bx-rest 0.9.8 → 0.9.10

package/fesm2022/bx-rest.mjs

@@ -1038,6 +1038,11 @@ const $pin = 'pin';
 const $end = 'end';
 const $idle = 'idle';
 const $crm = 'crm';
+const $automation = 'automation';
+const $trigger = 'trigger';
+const $execute = 'execute';
+const $enum = 'enum';
+const $multifield = 'multifield';
 const $lead = 'lead';
 const $deal = 'deal';
 const $contact = 'contact';
@@ -1056,6 +1061,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $application: $application,
     $approve: $approve,
     $attach: $attach,
+    $automation: $automation,
     $bizproc: $bizproc,
     $blogcomment: $blogcomment,
     $blogpost: $blogpost,
@@ -1083,7 +1089,9 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $elapseditem: $elapseditem,
     $element: $element,
     $end: $end,
+    $enum: $enum,
     $event: $event,
+    $execute: $execute,
     $favorite: $favorite,
     $feature: $feature,
     $field: $field,
@@ -1117,6 +1125,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $message: $message,
     $messages: $messages,
     $moveto: $moveto,
+    $multifield: $multifield,
     $mute: $mute,
     $nearest: $nearest,
     $params: $params,
@@ -1156,6 +1165,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $terminate: $terminate,
     $time: $time,
     $timeMan: $timeMan,
+    $trigger: $trigger,
     $type: $type,
     $unread: $unread,
     $update: $update,
@@ -6496,8 +6506,223 @@ class BXRestNavvyCrmQuote {
     }
 }
 
+/** Перечисления настроек CRM (`crm.enum.settings.*`). */
+class BXRestNavvyCrmEnumSettings {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            mode: [$crm, 'enum', $settings, 'mode']
+        };
+    }
+    /**
+     * Возвращает список режимов работы CRM для расшифровки значения,
+     * полученного методом `crm.settings.mode.get`.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-settings-mode.html
+     */
+    mode() {
+        return this.Navvy.simple(this.url.mode);
+    }
+}
+
+/** Методы перечислений CRM (`crm.enum.*`). */
+class BXRestNavvyCrmEnum {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            fields: [$crm, $enum, 'fields'],
+            ownertype: [$crm, $enum, 'ownertype'],
+            addresstype: [$crm, $enum, 'addresstype'],
+            activitytype: [$crm, $enum, 'activitytype'],
+            activitypriority: [$crm, $enum, 'activitypriority'],
+            activitydirection: [$crm, $enum, 'activitydirection'],
+            activitynotifytype: [$crm, $enum, 'activitynotifytype'],
+            activitystatus: [$crm, $enum, 'activitystatus'],
+            contenttype: [$crm, $enum, 'contenttype'],
+            getorderownertypes: [$crm, $enum, 'getorderownertypes']
+        };
+        /** Перечисления настроек CRM (`crm.enum.settings.*`). */
+        this.settings = new BXRestNavvyCrmEnumSettings();
+    }
+    /**
+     * Возвращает описание полей элементов перечислений CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-fields.html
+     */
+    fields() {
+        return this.Navvy.simple(this.url.fields);
+    }
+    /**
+     * Возвращает типы объектов CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-owner-type.html
+     */
+    ownertype() {
+        return this.enumItems(this.url.ownertype);
+    }
+    /**
+     * Возвращает типы адресов CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-address-type.html
+     */
+    addresstype() {
+        return this.enumItems(this.url.addresstype);
+    }
+    /**
+     * Возвращает значения поля `TYPE_ID` дел CRM.
+     *
+     * @deprecated Развитие метода остановлено. Используйте `crm.activity.todo.*`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-type.html
+     */
+    activitytype() {
+        return this.enumItems(this.url.activitytype);
+    }
+    /**
+     * Возвращает приоритеты дел CRM.
+     *
+     * @deprecated Развитие метода остановлено. Используйте `crm.activity.todo.*`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-priority.html
+     */
+    activitypriority() {
+        return this.enumItems(this.url.activitypriority);
+    }
+    /**
+     * Возвращает направления активности: входящее и исходящее.
+     *
+     * @deprecated Развитие метода остановлено. Используйте `crm.activity.todo.*`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-direction.html
+     */
+    activitydirection() {
+        return this.enumItems(this.url.activitydirection);
+    }
+    /**
+     * Возвращает типы уведомлений о начале активности.
+     *
+     * @deprecated Развитие метода остановлено. Используйте `crm.activity.todo.*`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-notify-type.html
+     */
+    activitynotifytype() {
+        return this.enumItems(this.url.activitynotifytype);
+    }
+    /**
+     * Возвращает статусы активности.
+     *
+     * @deprecated Развитие метода остановлено. Используйте `crm.activity.todo.*`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-status.html
+     */
+    activitystatus() {
+        return this.enumItems(this.url.activitystatus);
+    }
+    /**
+     * Возвращает типы описания дел: 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() {
+        return this.enumItems(this.url.contenttype);
+    }
+    /**
+     * Возвращает типы объектов, к которым можно привязать заказ.
+     * Идентификатор результата передаётся как `ownerTypeId` в `crm.orderentity.*`.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/enum/crm-enum-get-order-owner-types.html
+     */
+    getorderownertypes() {
+        return this.Navvy.simple(this.url.getorderownertypes);
+    }
+    enumItems(url) {
+        return this.Navvy.simple(url);
+    }
+}
+
+/** Методы описания множественных полей CRM (`crm.multifield.*`). */
+class BXRestNavvyCrmMultifield {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            fields: [$crm, $multifield, 'fields']
+        };
+    }
+    /**
+     * Возвращает описание множественных полей для телефонов, email-адресов
+     * и другой контактной информации лидов, контактов и компаний.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/auxiliary/multifield/crm-multifield-fields.html
+     */
+    fields() {
+        return this.Navvy.simple(this.url.fields);
+    }
+}
+
+/** Методы автоматизации CRM (`crm.automation.*`). */
+class BXRestNavvyCrmAutomation {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            trigger: [$crm, $automation, $trigger],
+            triggerAdd: [$crm, $automation, $trigger, $add],
+            triggerList: [$crm, $automation, $trigger, $list],
+            triggerExecute: [$crm, $automation, $trigger, $execute],
+            triggerDelete: [$crm, $automation, $trigger, $delete]
+        };
+        /**
+         * Запускает webhook-триггер, настроенный в автоматизации CRM.
+         * Значение `target` передается в формате `TYPENAME_ID`, например `DEAL_25`.
+         *
+         * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/crm-automation-trigger.html
+         */
+        this.trigger = Object.assign((param) => {
+            return this.Navvy.simple(this.url.trigger, param);
+        }, {
+            /**
+             * Добавляет триггер приложения.
+             * Метод доступен только в контексте приложения; повторный `CODE` обновит `NAME`.
+             *
+             * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-add.html
+             */
+            add: (param) => {
+                return this.Navvy.simple(this.url.triggerAdd, param);
+            },
+            /**
+             * Возвращает список триггеров приложения.
+             * Метод доступен только в контексте приложения.
+             *
+             * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-list.html
+             */
+            list: () => {
+                return this.Navvy.simple(this.url.triggerList);
+            },
+            /**
+             * Запускает триггер приложения для конкретного объекта CRM.
+             * Тип объекта берется из `crm.enum.ownertype`, идентификатор объекта - из CRM-элемента.
+             *
+             * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-execute.html
+             */
+            execute: (param) => {
+                return this.Navvy.simple(this.url.triggerExecute, param);
+            },
+            /**
+             * Удаляет триггер приложения.
+             * Метод доступен только в контексте приложения.
+             *
+             * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-delete.html
+             */
+            delete: (param) => {
+                return this.Navvy.simple(this.url.triggerDelete, param);
+            }
+        });
+    }
+}
+
 class BXRestNavvyCrm {
     constructor() {
+        /** Автоматизация CRM (`crm.automation.*`). */
+        this.automation = new BXRestNavvyCrmAutomation();
+        /** Перечисления CRM (`crm.enum.*`). */
+        this.enum = new BXRestNavvyCrmEnum();
+        /** Описание множественных полей CRM (`crm.multifield.*`). */
+        this.multifield = new BXRestNavvyCrmMultifield();
         this.lead = new BXRestNavvyCrmLead();
         this.deal = new BXRestNavvyCrmDeal();
         this.contact = new BXRestNavvyCrmContact();