bx-rest 0.10.2 → 0.10.4

package/fesm2022/bx-rest.mjs

@@ -1021,6 +1021,13 @@ const $pin = 'pin';
 const $end = 'end';
 const $idle = 'idle';
 const $crm = 'crm';
+const $duplicate = 'duplicate';
+const $entity = 'entity';
+const $findbycomm = 'findbycomm';
+const $mergeBatch = 'mergeBatch';
+const $volatileType = 'volatileType';
+const $register = 'register';
+const $unregister = 'unregister';
 const $automation = 'automation';
 const $automatedsolution = 'automatedsolution';
 const $trigger = 'trigger';
@@ -1080,10 +1087,12 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $disk: $disk,
     $document: $document,
     $documentgenerator: $documentgenerator,
+    $duplicate: $duplicate,
     $elapseditem: $elapseditem,
     $element: $element,
     $enablepublicurl: $enablepublicurl,
     $end: $end,
+    $entity: $entity,
     $enum: $enum,
     $event: $event,
     $execute: $execute,
@@ -1092,6 +1101,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $field: $field,
     $file: $file,
     $files: $files,
+    $findbycomm: $findbycomm,
     $folder: $folder,
     $get: $get,
     $getFields: $getFields,
@@ -1117,6 +1127,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $log: $log,
     $markdeleted: $markdeleted,
     $meeting: $meeting,
+    $mergeBatch: $mergeBatch,
     $message: $message,
     $messages: $messages,
     $moveto: $moveto,
@@ -1134,6 +1145,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $quote: $quote,
     $read: $read,
     $recent: $recent,
+    $register: $register,
     $rename: $rename,
     $renew: $renew,
     $request: $request,
@@ -1164,6 +1176,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $trigger: $trigger,
     $type: $type,
     $unread: $unread,
+    $unregister: $unregister,
     $update: $update,
     $updateAvatar: $updateAvatar,
     $updateColor: $updateColor,
@@ -1174,6 +1187,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $user: $user,
     $userfield: $userfield,
     $users: $users,
+    $volatileType: $volatileType,
     $workflow: $workflow,
     $workgroup: $workgroup,
     $writing: $writing
@@ -6225,6 +6239,30 @@ class BXRestMapCrmCurrency {
     }
 }
 
+class BXRestMapCrmStatus {
+    /** Преобразует список элементов справочника из формата Bitrix24 в локальный формат. */
+    static list(value) {
+        return value?.map(item => BXRestMapCrmStatus.get(item));
+    }
+    /** Преобразует элемент справочника из формата Bitrix24 в локальный формат. */
+    static get(value) {
+        if (!value)
+            return undefined;
+        return Object.assign(clone(value), {
+            ID: toNum(value.ID),
+            SORT: toNum(value.SORT),
+            SYSTEM: toBool(value.SYSTEM),
+            CATEGORY_ID: value.CATEGORY_ID === null ? null : toNum(value.CATEGORY_ID)
+        });
+    }
+    /** Нормализует идентификаторы воронок в описаниях типов справочников. */
+    static entityTypes(value) {
+        return value?.map(item => Object.assign(clone(item), {
+            CATEGORY_ID: item.CATEGORY_ID === undefined ? undefined : toNum(item.CATEGORY_ID)
+        }));
+    }
+}
+
 class BXRestNavvyCrmLead {
     constructor() {
         this.url = {
@@ -7301,8 +7339,208 @@ class BXRestNavvyCrmCurrency {
     }
 }
 
+/** Навигатор методов описания типов справочников CRM (`crm.status.entity.*`). */
+class BXRestNavvyCrmStatusEntity {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            items: [$crm, $status, 'entity', 'items'],
+            types: [$crm, $status, 'entity', 'types']
+        };
+    }
+    /**
+     * Возвращает все элементы указанного справочника с сортировкой по полю `SORT`.
+     *
+     * @param param Символьный идентификатор справочника в поле `entityId`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-entity-items.html
+     */
+    items(param) {
+        return this.Navvy.simple(this.url.items, param);
+    }
+    /**
+     * Возвращает все поддерживаемые типы справочников и их символьные идентификаторы.
+     * Для справочников стадий ответ также содержит сведения о воронке и семантике.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-entity-types.html
+     */
+    types() {
+        return this.Navvy.simple(this.url.types, undefined, BXRestMapCrmStatus.entityTypes);
+    }
+}
+
+/** Навигатор REST-методов справочников CRM (`crm.status.*`). */
+class BXRestNavvyCrmStatus {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            add: [$crm, $status, $add],
+            update: [$crm, $status, $update],
+            get: [$crm, $status, $get],
+            list: [$crm, $status, $list],
+            delete: [$crm, $status, $delete],
+            fields: [$crm, $status, 'fields']
+        };
+        /** Типы справочников и получение их элементов (`crm.status.entity.*`). */
+        this.entity = new BXRestNavvyCrmStatusEntity();
+    }
+    /**
+     * Создает новый элемент в указанном справочнике CRM.
+     * Для стадий пользовательских воронок Bitrix24 автоматически добавляет к `STATUS_ID` префикс воронки.
+     *
+     * @param param Тип справочника и поля нового элемента.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-add.html
+     */
+    add(param) {
+        return this.Navvy.simple(this.url.add, param);
+    }
+    /**
+     * Обновляет название, сортировку или цвет существующего элемента справочника.
+     *
+     * @param param Идентификатор элемента и изменяемые поля.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-update.html
+     */
+    update(param) {
+        return this.Navvy.simple(this.url.update, param);
+    }
+    /**
+     * Возвращает элемент справочника по числовому идентификатору.
+     *
+     * @param param Идентификатор элемента справочника.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-get.html
+     */
+    get(param) {
+        return this.Navvy.simple(this.url.get, param, BXRestMapCrmStatus.get);
+    }
+    /**
+     * Возвращает список элементов справочников по фильтру с заданной сортировкой.
+     * Навигатор поддерживает получение всех страниц результата через `resAll()`.
+     *
+     * @param param Фильтр, сортировка и начальная позиция страницы.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-list.html
+     */
+    list(param = {}) {
+        return this.Navvy.pagNav(this.url.list, param, BXRestMapCrmStatus.list);
+    }
+    /**
+     * Удаляет элемент справочника.
+     * Для системного элемента передайте `params.FORCED: 'Y'`.
+     *
+     * @param param Идентификатор элемента и необязательный флаг принудительного удаления.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+    /**
+     * Возвращает описание полей элементов справочников CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-fields.html
+     */
+    fields() {
+        return this.Navvy.simple(this.url.fields);
+    }
+}
+
+/** Настройка дополнительных полей поиска дубликатов (`crm.duplicate.volatileType.*`). */
+class BXRestNavvyCrmDuplicateVolatileType {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            fields: [$crm, $duplicate, $volatileType, 'fields'],
+            list: [$crm, $duplicate, $volatileType, $list],
+            register: [$crm, $duplicate, $volatileType, $register],
+            unregister: [$crm, $duplicate, $volatileType, $unregister]
+        };
+    }
+    /**
+     * Возвращает стандартные и пользовательские поля, доступные для поиска дубликатов.
+     *
+     * @param param Необязательный тип CRM-объекта: `1` — лид, `3` — контакт, `4` — компания.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-fields.html
+     */
+    fields(param = {}) {
+        return this.Navvy.simple(this.url.fields, param);
+    }
+    /**
+     * Возвращает нестандартные поля, уже участвующие в поиске дубликатов.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-list.html
+     */
+    list() {
+        return this.Navvy.simple(this.url.list);
+    }
+    /**
+     * Добавляет стандартное или пользовательское поле в поиск дубликатов.
+     * Суммарно для лидов, контактов и компаний можно зарегистрировать до семи полей.
+     *
+     * @param param Тип CRM-объекта и код поля из результата метода `fields`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-register.html
+     */
+    register(param) {
+        return this.Navvy.simple(this.url.register, param);
+    }
+    /**
+     * Удаляет нестандартное поле из поиска дубликатов.
+     *
+     * @param param Идентификатор записи из результата метода `list` или `register`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-unregister.html
+     */
+    unregister(param) {
+        return this.Navvy.simple(this.url.unregister, param);
+    }
+}
+
+/** Поиск дубликатов и настройка полей поиска (`crm.duplicate.*`). */
+class BXRestNavvyCrmDuplicate {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            findByComm: [$crm, $duplicate, $findbycomm]
+        };
+        /** Дополнительные поля поиска дубликатов (`crm.duplicate.volatileType.*`). */
+        this.volatileType = new BXRestNavvyCrmDuplicateVolatileType();
+    }
+    /**
+     * Возвращает идентификаторы лидов, контактов и компаний с совпадающими телефонами или email.
+     * Добавочный номер телефона при поиске не учитывается; за один вызов можно передать до 20 значений.
+     *
+     * @param param Тип коммуникации, искомые значения и необязательное ограничение типа CRM-объекта.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/duplicates/crm-duplicate-find-by-comm.html
+     */
+    findByComm(param) {
+        return this.Navvy.simple(this.url.findByComm, param);
+    }
+}
+
+/** Операции над универсальными CRM-объектами (`crm.entity.*`). */
+class BXRestNavvyCrmEntity {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            mergeBatch: [$crm, $entity, $mergeBatch]
+        };
+    }
+    /**
+     * Объединяет несколько CRM-объектов одного типа.
+     * Первый идентификатор определяет главный объект; остальные объекты удаляются после успеха.
+     * При статусе `CONFLICT` конфликтующие значения необходимо объединить вручную в интерфейсе Bitrix24.
+     *
+     * @param param Тип объекта и идентификаторы как минимум двух объединяемых элементов.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/duplicates/crm-entity-merge-batch.html
+     */
+    mergeBatch(param) {
+        return this.Navvy.simple(this.url.mergeBatch, param);
+    }
+}
+
 class BXRestNavvyCrm {
     constructor() {
+        /** Поиск дубликатов и настройка его полей (`crm.duplicate.*`). */
+        this.duplicate = new BXRestNavvyCrmDuplicate();
+        /** Операции над универсальными CRM-объектами (`crm.entity.*`). */
+        this.entity = new BXRestNavvyCrmEntity();
+        /** Справочники CRM (`crm.status.*`). */
+        this.status = new BXRestNavvyCrmStatus();
         /** Валюты CRM (`crm.currency.*`). */
         this.currency = new BXRestNavvyCrmCurrency();
         /** Генератор документов CRM (`crm.documentgenerator.*`). */