bx-rest 0.9.8 → 0.9.10

package/package.json

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

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

@@ -0,0 +1,42 @@
+import { iBXRestCrmAutomationTrigger, iBXRestParamCrmAutomationTrigger, iBXRestParamCrmAutomationTriggerAdd, iBXRestParamCrmAutomationTriggerDelete, iBXRestParamCrmAutomationTriggerExecute } from '../../../typification/rest/crm';
+/** Методы автоматизации CRM (`crm.automation.*`). */
+export declare class BXRestNavvyCrmAutomation {
+    private readonly Navvy;
+    private readonly url;
+    /**
+     * Запускает webhook-триггер, настроенный в автоматизации CRM.
+     * Значение `target` передается в формате `TYPENAME_ID`, например `DEAL_25`.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/crm-automation-trigger.html
+     */
+    readonly trigger: ((param: iBXRestParamCrmAutomationTrigger) => import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmAutomationTrigger | undefined>) & {
+        /**
+         * Добавляет триггер приложения.
+         * Метод доступен только в контексте приложения; повторный `CODE` обновит `NAME`.
+         *
+         * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-add.html
+         */
+        add: (param: iBXRestParamCrmAutomationTriggerAdd) => import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmAutomationTriggerAdd | undefined>;
+        /**
+         * Возвращает список триггеров приложения.
+         * Метод доступен только в контексте приложения.
+         *
+         * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-list.html
+         */
+        list: () => import("../../../services/navvy").NavvySimple<iBXRestCrmAutomationTrigger[], iBXRestCrmAutomationTrigger[], undefined>;
+        /**
+         * Запускает триггер приложения для конкретного объекта CRM.
+         * Тип объекта берется из `crm.enum.ownertype`, идентификатор объекта - из CRM-элемента.
+         *
+         * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-execute.html
+         */
+        execute: (param: iBXRestParamCrmAutomationTriggerExecute) => import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmAutomationTriggerExecute | undefined>;
+        /**
+         * Удаляет триггер приложения.
+         * Метод доступен только в контексте приложения.
+         *
+         * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-delete.html
+         */
+        delete: (param: iBXRestParamCrmAutomationTriggerDelete) => import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmAutomationTriggerDelete | undefined>;
+    };
+}

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

@@ -0,0 +1,78 @@
+import { iBXRestCrmEnumFields, iBXRestCrmEnumItem, iBXRestCrmOrderOwnerType } from '../../../typification/rest/crm';
+import { BXRestNavvyCrmEnumSettings } from './settings';
+export * from './settings';
+/** Методы перечислений CRM (`crm.enum.*`). */
+export declare class BXRestNavvyCrmEnum {
+    private readonly Navvy;
+    private readonly url;
+    /** Перечисления настроек CRM (`crm.enum.settings.*`). */
+    readonly settings: BXRestNavvyCrmEnumSettings;
+    /**
+     * Возвращает описание полей элементов перечислений CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-fields.html
+     */
+    fields(): import("../../../services/navvy").NavvySimple<iBXRestCrmEnumFields, iBXRestCrmEnumFields, undefined>;
+    /**
+     * Возвращает типы объектов CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-owner-type.html
+     */
+    ownertype(): import("../../../services/navvy").NavvySimple<iBXRestCrmEnumItem[], iBXRestCrmEnumItem[], undefined>;
+    /**
+     * Возвращает типы адресов CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-address-type.html
+     */
+    addresstype(): import("../../../services/navvy").NavvySimple<iBXRestCrmEnumItem[], iBXRestCrmEnumItem[], undefined>;
+    /**
+     * Возвращает значения поля `TYPE_ID` дел CRM.
+     *
+     * @deprecated Развитие метода остановлено. Используйте `crm.activity.todo.*`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-type.html
+     */
+    activitytype(): import("../../../services/navvy").NavvySimple<iBXRestCrmEnumItem[], iBXRestCrmEnumItem[], undefined>;
+    /**
+     * Возвращает приоритеты дел CRM.
+     *
+     * @deprecated Развитие метода остановлено. Используйте `crm.activity.todo.*`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-priority.html
+     */
+    activitypriority(): import("../../../services/navvy").NavvySimple<iBXRestCrmEnumItem[], iBXRestCrmEnumItem[], undefined>;
+    /**
+     * Возвращает направления активности: входящее и исходящее.
+     *
+     * @deprecated Развитие метода остановлено. Используйте `crm.activity.todo.*`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-direction.html
+     */
+    activitydirection(): import("../../../services/navvy").NavvySimple<iBXRestCrmEnumItem[], iBXRestCrmEnumItem[], undefined>;
+    /**
+     * Возвращает типы уведомлений о начале активности.
+     *
+     * @deprecated Развитие метода остановлено. Используйте `crm.activity.todo.*`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-notify-type.html
+     */
+    activitynotifytype(): import("../../../services/navvy").NavvySimple<iBXRestCrmEnumItem[], iBXRestCrmEnumItem[], undefined>;
+    /**
+     * Возвращает статусы активности.
+     *
+     * @deprecated Развитие метода остановлено. Используйте `crm.activity.todo.*`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-status.html
+     */
+    activitystatus(): import("../../../services/navvy").NavvySimple<iBXRestCrmEnumItem[], iBXRestCrmEnumItem[], undefined>;
+    /**
+     * Возвращает типы описания дел: plain text, bbCode и HTML.
+     *
+     * @deprecated Развитие метода остановлено. Используйте `crm.activity.todo.*`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-content-type.html
+     */
+    contenttype(): import("../../../services/navvy").NavvySimple<iBXRestCrmEnumItem[], iBXRestCrmEnumItem[], undefined>;
+    /**
+     * Возвращает типы объектов, к которым можно привязать заказ.
+     * Идентификатор результата передаётся как `ownerTypeId` в `crm.orderentity.*`.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-get-order-owner-types.html
+     */
+    getorderownertypes(): import("../../../services/navvy").NavvySimple<iBXRestCrmOrderOwnerType[], iBXRestCrmOrderOwnerType[], undefined>;
+    private enumItems;
+}

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

@@ -0,0 +1,13 @@
+import { iBXRestCrmEnumItem } from '../../../typification/rest/crm';
+/** Перечисления настроек CRM (`crm.enum.settings.*`). */
+export declare class BXRestNavvyCrmEnumSettings {
+    private readonly Navvy;
+    private readonly url;
+    /**
+     * Возвращает список режимов работы CRM для расшифровки значения,
+     * полученного методом `crm.settings.mode.get`.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-settings-mode.html
+     */
+    mode(): import("../../../services/navvy").NavvySimple<iBXRestCrmEnumItem[], iBXRestCrmEnumItem[], undefined>;
+}

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

@@ -0,0 +1,13 @@
+import { iBXRestCrmMultifieldFields } from '../../typification/rest/crm';
+/** Методы описания множественных полей CRM (`crm.multifield.*`). */
+export declare class BXRestNavvyCrmMultifield {
+    private readonly Navvy;
+    private readonly url;
+    /**
+     * Возвращает описание множественных полей для телефонов, email-адресов
+     * и другой контактной информации лидов, контактов и компаний.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/multifield/crm-multifield-fields.html
+     */
+    fields(): import("../../services/navvy").NavvySimple<iBXRestCrmMultifieldFields, iBXRestCrmMultifieldFields, undefined>;
+}

package/request-navvy/crm.d.ts

@@ -3,7 +3,16 @@ import { BXRestNavvyCrmDeal } from './crm/deal';
 import { BXRestNavvyCrmContact } from './crm/contact';
 import { BXRestNavvyCrmCompany } from './crm/company';
 import { BXRestNavvyCrmQuote } from './crm/quote/index';
+import { BXRestNavvyCrmEnum } from './crm/enum/index';
+import { BXRestNavvyCrmMultifield } from './crm/multifield';
+import { BXRestNavvyCrmAutomation } from './crm/automation/index';
 export declare class BXRestNavvyCrm {
+    /** Автоматизация CRM (`crm.automation.*`). */
+    readonly automation: BXRestNavvyCrmAutomation;
+    /** Перечисления CRM (`crm.enum.*`). */
+    readonly enum: BXRestNavvyCrmEnum;
+    /** Описание множественных полей CRM (`crm.multifield.*`). */
+    readonly multifield: BXRestNavvyCrmMultifield;
     readonly lead: BXRestNavvyCrmLead;
     readonly deal: BXRestNavvyCrmDeal;
     readonly contact: BXRestNavvyCrmContact;

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

@@ -0,0 +1,35 @@
+/** Параметры запуска webhook-триггера, настроенного в автоматизации CRM. */
+export interface iBXRestParamCrmAutomationTrigger {
+    /** Целевой объект автоматизации в формате `TYPENAME_ID`, например `DEAL_25`. */
+    target: string;
+    /** Символьный код триггера из настроек автоматизации CRM. */
+    code?: string;
+}
+/** Параметры регистрации триггера приложения. */
+export interface iBXRestParamCrmAutomationTriggerAdd {
+    /** Внутренний уникальный идентификатор триггера в рамках приложения. */
+    CODE: string;
+    /** Название триггера. */
+    NAME: string;
+}
+/** Триггер приложения, зарегистрированный в автоматизации CRM. */
+export interface iBXRestCrmAutomationTrigger {
+    /** Название триггера. */
+    NAME: string;
+    /** Внутренний уникальный идентификатор триггера в рамках приложения. */
+    CODE: string;
+}
+/** Параметры запуска триггера приложения для объекта CRM. */
+export interface iBXRestParamCrmAutomationTriggerExecute {
+    /** Внутренний уникальный идентификатор триггера в рамках приложения. */
+    CODE: string;
+    /** Тип объекта CRM из справочника `crm.enum.ownertype`. */
+    OWNER_TYPE_ID: number;
+    /** Идентификатор элемента CRM. */
+    OWNER_ID: number;
+}
+/** Параметры удаления триггера приложения. */
+export interface iBXRestParamCrmAutomationTriggerDelete {
+    /** Внутренний уникальный идентификатор триггера в рамках приложения. */
+    CODE: string;
+}

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

@@ -0,0 +1,46 @@
+/** Характеристики поля, возвращаемые методами описания полей CRM. */
+export interface iBXRestCrmFieldDescription {
+    /** Тип данных поля. */
+    type: string;
+    /** Является ли поле обязательным. */
+    isRequired: boolean;
+    /** Доступно ли поле только для чтения. */
+    isReadOnly: boolean;
+    /** Является ли поле неизменяемым. */
+    isImmutable: boolean;
+    /** Является ли поле множественным. */
+    isMultiple: boolean;
+    /** Является ли поле динамическим. */
+    isDynamic: boolean;
+    /** Отображаемое название поля. */
+    title: string;
+}
+/** Описание полей стандартного элемента перечисления CRM. */
+export interface iBXRestCrmEnumFields {
+    ID: iBXRestCrmFieldDescription;
+    NAME: iBXRestCrmFieldDescription;
+    SYMBOL_CODE: iBXRestCrmFieldDescription;
+    SYMBOL_CODE_SHORT: iBXRestCrmFieldDescription;
+}
+/** Стандартный элемент перечисления CRM. */
+export interface iBXRestCrmEnumItem {
+    /** Идентификатор элемента. */
+    ID: number;
+    /** Название элемента. */
+    NAME: string;
+    /** Символьный код, если он задан для этого перечисления. */
+    SYMBOL_CODE: string | null;
+    /** Краткий символьный код, если он задан для этого перечисления. */
+    SYMBOL_CODE_SHORT: string | null;
+}
+/** Тип объекта, к которому можно привязать заказ. */
+export interface iBXRestCrmOrderOwnerType {
+    /** Атрибут типа объекта. */
+    attribute: string;
+    /** Код типа объекта. */
+    code: string;
+    /** Идентификатор типа объекта для `ownerTypeId` методов `crm.orderentity.*`. */
+    id: number;
+    /** Название типа объекта. */
+    name: string;
+}

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

@@ -3,3 +3,6 @@ export * from './deal';
 export * from './contact';
 export * from './company';
 export * from './quote';
+export * from './enum';
+export * from './multifield';
+export * from './automation';

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

@@ -0,0 +1,12 @@
+import { iBXRestCrmFieldDescription } from './enum';
+/** Описание полей элемента множественного поля CRM. */
+export interface iBXRestCrmMultifieldFields {
+    /** Идентификатор элемента множественного поля. */
+    ID: iBXRestCrmFieldDescription;
+    /** Тип поля: телефон, email, мессенджер и другие. */
+    TYPE_ID: iBXRestCrmFieldDescription;
+    /** Значение поля. */
+    VALUE: iBXRestCrmFieldDescription;
+    /** Тип значения, например рабочий или мобильный телефон. */
+    VALUE_TYPE: iBXRestCrmFieldDescription;
+}