bx-rest 0.10.3 → 0.10.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bx-rest",
-  "version": "0.10.3",
+  "version": "0.10.4",
   "description": "Bitrix24 REST API client and TypeScript SDK for Angular, Vue and browser apps",
   "keywords": [
     "bitrix",

package/request-navvy/crm/duplicate/index.d.ts

@@ -0,0 +1,18 @@
+import { iBXRestParamCrmDuplicateFindByComm } from '../../../typification/rest/crm';
+import { BXRestNavvyCrmDuplicateVolatileType } from './volatile-type';
+export * from './volatile-type';
+/** Поиск дубликатов и настройка полей поиска (`crm.duplicate.*`). */
+export declare class BXRestNavvyCrmDuplicate {
+    private readonly Navvy;
+    private readonly url;
+    /** Дополнительные поля поиска дубликатов (`crm.duplicate.volatileType.*`). */
+    readonly volatileType: BXRestNavvyCrmDuplicateVolatileType;
+    /**
+     * Возвращает идентификаторы лидов, контактов и компаний с совпадающими телефонами или email.
+     * Добавочный номер телефона при поиске не учитывается; за один вызов можно передать до 20 значений.
+     *
+     * @param param Тип коммуникации, искомые значения и необязательное ограничение типа CRM-объекта.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/duplicates/crm-duplicate-find-by-comm.html
+     */
+    findByComm(param: iBXRestParamCrmDuplicateFindByComm): import("../../../services/navvy").NavvySimple<Partial<Record<import("../../../typification/rest/crm").iBXRestCrmDuplicateEntityType, number[]>>, Partial<Record<import("../../../typification/rest/crm").iBXRestCrmDuplicateEntityType, number[]>>, iBXRestParamCrmDuplicateFindByComm | undefined>;
+}

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

@@ -0,0 +1,34 @@
+import { iBXRestCrmDuplicateVolatileType, iBXRestCrmDuplicateVolatileTypeField, iBXRestCrmDuplicateVolatileTypeRegisterResult, iBXRestParamCrmDuplicateVolatileTypeFields, iBXRestParamCrmDuplicateVolatileTypeRegister, iBXRestParamCrmDuplicateVolatileTypeUnregister } from '../../../typification/rest/crm';
+/** Настройка дополнительных полей поиска дубликатов (`crm.duplicate.volatileType.*`). */
+export declare class BXRestNavvyCrmDuplicateVolatileType {
+    private readonly Navvy;
+    private readonly url;
+    /**
+     * Возвращает стандартные и пользовательские поля, доступные для поиска дубликатов.
+     *
+     * @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?: iBXRestParamCrmDuplicateVolatileTypeFields): import("../../../services/navvy").NavvySimple<iBXRestCrmDuplicateVolatileTypeField[], iBXRestCrmDuplicateVolatileTypeField[], iBXRestParamCrmDuplicateVolatileTypeFields | undefined>;
+    /**
+     * Возвращает нестандартные поля, уже участвующие в поиске дубликатов.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-list.html
+     */
+    list(): import("../../../services/navvy").NavvySimple<iBXRestCrmDuplicateVolatileType[], iBXRestCrmDuplicateVolatileType[], undefined>;
+    /**
+     * Добавляет стандартное или пользовательское поле в поиск дубликатов.
+     * Суммарно для лидов, контактов и компаний можно зарегистрировать до семи полей.
+     *
+     * @param param Тип CRM-объекта и код поля из результата метода `fields`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-register.html
+     */
+    register(param: iBXRestParamCrmDuplicateVolatileTypeRegister): import("../../../services/navvy").NavvySimple<iBXRestCrmDuplicateVolatileTypeRegisterResult, iBXRestCrmDuplicateVolatileTypeRegisterResult, iBXRestParamCrmDuplicateVolatileTypeRegister | undefined>;
+    /**
+     * Удаляет нестандартное поле из поиска дубликатов.
+     *
+     * @param param Идентификатор записи из результата метода `list` или `register`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-unregister.html
+     */
+    unregister(param: iBXRestParamCrmDuplicateVolatileTypeUnregister): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmDuplicateVolatileTypeUnregister | undefined>;
+}

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

@@ -0,0 +1,15 @@
+import { iBXRestCrmEntityMergeBatchResult, iBXRestParamCrmEntityMergeBatch } from '../../typification/rest/crm';
+/** Операции над универсальными CRM-объектами (`crm.entity.*`). */
+export declare class BXRestNavvyCrmEntity {
+    private readonly Navvy;
+    private readonly url;
+    /**
+     * Объединяет несколько CRM-объектов одного типа.
+     * Первый идентификатор определяет главный объект; остальные объекты удаляются после успеха.
+     * При статусе `CONFLICT` конфликтующие значения необходимо объединить вручную в интерфейсе Bitrix24.
+     *
+     * @param param Тип объекта и идентификаторы как минимум двух объединяемых элементов.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/duplicates/crm-entity-merge-batch.html
+     */
+    mergeBatch(param: iBXRestParamCrmEntityMergeBatch): import("../../services/navvy").NavvySimple<iBXRestCrmEntityMergeBatchResult, iBXRestCrmEntityMergeBatchResult, iBXRestParamCrmEntityMergeBatch | undefined>;
+}

package/request-navvy/crm.d.ts

@@ -10,7 +10,13 @@ import { BXRestNavvyCrmAutomatedSolution } from './crm/automatedsolution';
 import { BXRestNavvyCrmDocumentGenerator } from './crm/documentgenerator/index';
 import { BXRestNavvyCrmCurrency } from './crm/currency';
 import { BXRestNavvyCrmStatus } from './crm/status';
+import { BXRestNavvyCrmDuplicate } from './crm/duplicate/index';
+import { BXRestNavvyCrmEntity } from './crm/entity';
 export declare class BXRestNavvyCrm {
+    /** Поиск дубликатов и настройка его полей (`crm.duplicate.*`). */
+    readonly duplicate: BXRestNavvyCrmDuplicate;
+    /** Операции над универсальными CRM-объектами (`crm.entity.*`). */
+    readonly entity: BXRestNavvyCrmEntity;
     /** Справочники CRM (`crm.status.*`). */
     readonly status: BXRestNavvyCrmStatus;
     /** Валюты CRM (`crm.currency.*`). */

package/typification/rest/crm/duplicate.d.ts

@@ -0,0 +1,57 @@
+/** Тип CRM-объекта, поддерживаемый поиском дубликатов. */
+export type iBXRestCrmDuplicateEntityType = 'LEAD' | 'CONTACT' | 'COMPANY';
+/** Числовой идентификатор типа CRM-объекта, поддерживаемого настройкой поиска дубликатов. */
+export type iBXRestCrmDuplicateEntityTypeId = 1 | 3 | 4;
+/** Тип коммуникации, по которой выполняется поиск совпадений. */
+export type iBXRestCrmDuplicateCommunicationType = 'EMAIL' | 'PHONE';
+/** Параметры метода `crm.duplicate.findbycomm`. */
+export interface iBXRestParamCrmDuplicateFindByComm {
+    /** Тип коммуникации: email-адрес или телефон. */
+    type: iBXRestCrmDuplicateCommunicationType;
+    /** Email-адреса или телефоны для поиска. Метод принимает не более 20 значений. */
+    values: string[];
+    /** Ограничение поиска одним типом CRM-объекта. По умолчанию поиск идет по всем типам. */
+    entity_type?: iBXRestCrmDuplicateEntityType;
+}
+/** Идентификаторы CRM-объектов с совпадающими коммуникациями. */
+export type iBXRestCrmDuplicateFindByCommResult = Partial<Record<iBXRestCrmDuplicateEntityType, number[]>>;
+/** Параметры метода `crm.duplicate.volatileType.fields`. */
+export interface iBXRestParamCrmDuplicateVolatileTypeFields {
+    /** Тип CRM-объекта. Если не указан, возвращаются поля лидов, контактов и компаний. */
+    entityTypeId?: iBXRestCrmDuplicateEntityTypeId;
+}
+/** Поле, которое можно использовать для поиска дубликатов. */
+export interface iBXRestCrmDuplicateVolatileTypeField {
+    /** Тип CRM-объекта, которому принадлежит поле. */
+    entityTypeId: iBXRestCrmDuplicateEntityTypeId;
+    /** Код стандартного или пользовательского поля. */
+    fieldCode: string;
+    /** Отображаемое название поля. */
+    fieldTitle: string;
+}
+/** Параметры метода `crm.duplicate.volatileType.register`. */
+export interface iBXRestParamCrmDuplicateVolatileTypeRegister {
+    /** Тип CRM-объекта: `1` — лид, `3` — контакт, `4` — компания. */
+    entityTypeId: iBXRestCrmDuplicateEntityTypeId;
+    /** Код поля из результата `crm.duplicate.volatileType.fields`. */
+    fieldCode: string;
+}
+/** Результат добавления поля в поиск дубликатов. */
+export interface iBXRestCrmDuplicateVolatileTypeRegisterResult {
+    /** Идентификатор записи, необходимый для последующего удаления поля из поиска. */
+    id: number;
+}
+/** Нестандартное поле, уже участвующее в поиске дубликатов. */
+export interface iBXRestCrmDuplicateVolatileType {
+    /** Идентификатор записи о добавленном поле. */
+    id: number;
+    /** Тип CRM-объекта, которому принадлежит поле. */
+    entityTypeId: iBXRestCrmDuplicateEntityTypeId;
+    /** Код поля. */
+    fieldCode: string;
+}
+/** Параметры метода `crm.duplicate.volatileType.unregister`. */
+export interface iBXRestParamCrmDuplicateVolatileTypeUnregister {
+    /** Идентификатор записи из результата `crm.duplicate.volatileType.list` или `register`. */
+    id: number;
+}

package/typification/rest/crm/entity.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Идентификатор типа CRM-объекта для объединения.
+ *
+ * Стандартные значения: `1` — лид, `2` — сделка, `3` — контакт, `4` — компания,
+ * `7` — предложение, `31` — счет. Для смарт-процесса передается его динамический идентификатор.
+ */
+export type iBXRestCrmEntityTypeId = number;
+/** Параметры метода `crm.entity.mergeBatch`. */
+export interface iBXRestParamCrmEntityMergeBatch {
+    /** Контейнер параметров объединения. */
+    params: {
+        /** Идентификатор типа объединяемых CRM-объектов. */
+        entityTypeId: iBXRestCrmEntityTypeId;
+        /**
+         * Идентификаторы как минимум двух объектов одного типа.
+         * Первый объект становится главным, остальные удаляются после успешного объединения.
+         */
+        entityIds: number[];
+    };
+}
+/** Статус объединения CRM-объектов. */
+export type iBXRestCrmEntityMergeBatchStatus = 'SUCCESS' | 'CONFLICT' | 'ERROR';
+/** Результат метода `crm.entity.mergeBatch`. */
+export interface iBXRestCrmEntityMergeBatchResult {
+    /** Статус автоматического объединения. */
+    STATUS: iBXRestCrmEntityMergeBatchStatus;
+    /** Идентификаторы объектов, удаленных после успешного объединения. */
+    ENTITY_IDS: number[];
+}

package/typification/rest/crm/index.d.ts

@@ -10,3 +10,5 @@ export * from './automatedsolution';
 export * from './documentgenerator';
 export * from './currency';
 export * from './status';
+export * from './duplicate';
+export * from './entity';