bx-rest 0.10.7 → 0.11.1

package/fesm2022/bx-rest.mjs

@@ -908,6 +908,10 @@ const $get = 'get';
 const $add = 'add';
 const $set = 'set';
 const $event = 'event';
+const $events = 'events';
+const $offline = 'offline';
+const $clear = 'clear';
+const $error = 'error';
 const $update = 'update';
 const $user = 'user';
 const $task = 'task';
@@ -1097,6 +1101,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $calllist: $calllist,
     $channel: $channel,
     $chat: $chat,
+    $clear: $clear,
     $comment: $comment,
     $commentitem: $commentitem,
     $company: $company,
@@ -1126,7 +1131,9 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $end: $end,
     $entity: $entity,
     $enum: $enum,
+    $error: $error,
     $event: $event,
+    $events: $events,
     $execute: $execute,
     $favorite: $favorite,
     $feature: $feature,
@@ -1174,6 +1181,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $nearest: $nearest,
     $note: $note,
     $numerator: $numerator,
+    $offline: $offline,
     $params: $params,
     $pause: $pause,
     $pin: $pin,
@@ -4584,64 +4592,297 @@ class BXRestNavvyDisk {
     }
 }
 
+/** Задания бизнес-процессов (`bizproc.task.*`). */
 class BXRestNavvyBizProcTask {
     constructor() {
         this.Navvy = new Navvy();
+        this.url = {
+            /** Возвращает задания бизнес-процессов. */
+            list: [$bizproc, $task, $list],
+            /** Выполняет задание. */
+            complete: [$bizproc, $task, $complete],
+            /** Делегирует задания другому пользователю. */
+            delegate: [$bizproc, $task, $delegate]
+        };
     }
     /**
-     * Возвращает список заданий бизнес-процессов
+     * Возвращает список заданий бизнес-процессов.
+     *
+     * Если `USER_ID` не задан, обычный пользователь получает только свои
+     * задания; руководитель и администратор могут запрашивать задания других.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-task/bizproc-task-list.html
      */
     list(param = {}) {
-        return this.Navvy.pagNav([$bizproc, $task, $list], param);
+        return this.Navvy.pagNav(this.url.list, param);
     }
     /**
-     * Выполняет задание бизнес-процесса
+     * Выполняет доступное текущему пользователю задание бизнес-процесса.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-task/bizproc-task-complete.html
      */
     complete(param) {
-        return this.Navvy.simple([$bizproc, $task, $complete], param);
+        return this.Navvy.simple(this.url.complete, param);
     }
     /**
-     * Делегирует задания бизнес-процесса другому пользователю
+     * Делегирует задания бизнес-процесса другому пользователю.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-task/bizproc-task-delegate.html
      */
     delegate(param) {
-        return this.Navvy.simple([$bizproc, $task, $delegate], param);
+        return this.Navvy.simple(this.url.delegate, param);
+    }
+}
+
+/** Шаблоны бизнес-процессов (`bizproc.workflow.template.*`). */
+class BXRestNavvyBizProcWorkflowTemplate {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Добавляет шаблон из файла `.bpt`. */
+            add: [$bizproc, $workflow, $template, $add],
+            /** Обновляет шаблон, созданный текущим приложением. */
+            update: [$bizproc, $workflow, $template, $update],
+            /** Удаляет шаблон, созданный текущим приложением. */
+            delete: [$bizproc, $workflow, $template, $delete],
+            /** Возвращает список шаблонов. */
+            list: [$bizproc, $workflow, $template, $list]
+        };
+    }
+    /**
+     * Добавляет шаблон бизнес-процесса из файла `.bpt`.
+     *
+     * Метод работает только в контексте приложения и привязывает новый шаблон
+     * к вызвавшему его приложению.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-add.html
+     */
+    add(param) {
+        return this.Navvy.simple(this.url.add, param);
+    }
+    /**
+     * Обновляет шаблон, ранее созданный текущим приложением.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-update.html
+     */
+    update(param) {
+        return this.Navvy.simple(this.url.update, param);
+    }
+    /**
+     * Удаляет шаблон, ранее созданный текущим приложением.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+    /**
+     * Возвращает список шаблонов с выборкой полей, фильтрацией и сортировкой.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-list.html
+     */
+    list(param = {}) {
+        return this.Navvy.pagNav(this.url.list, param);
     }
 }
 
+/** Запущенные бизнес-процессы (`bizproc.workflow.*`). */
 class BXRestNavvyBXRestBizProcWorkflow {
     constructor() {
         this.Navvy = new Navvy();
+        /** Операции с шаблонами бизнес-процессов. */
+        this.template = new BXRestNavvyBizProcWorkflowTemplate();
+        this.url = {
+            /** Запускает бизнес-процесс. */
+            start: [$bizproc, $workflow, $start],
+            /** Возвращает запущенные бизнес-процессы. */
+            instances: [$bizproc, $workflow, $instances],
+            /** Останавливает процесс с сохранением данных. */
+            terminate: [$bizproc, $workflow, $terminate],
+            /** Удаляет процесс вместе с его данными. */
+            kill: [$bizproc, $workflow, $kill]
+        };
     }
     /**
-     * Запускает Бизнес-процесс
+     * Запускает новый бизнес-процесс по шаблону для указанного документа.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-start.html
      */
     start(param) {
-        return this.Navvy.simple([$bizproc, $workflow, $start], param);
+        return this.Navvy.simple(this.url.start, param);
     }
     /**
-     * Возвращает список запущенных бизнес-процессов
+     * Возвращает список запущенных бизнес-процессов.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-instances.html
      */
     instances(param = {}) {
-        return this.Navvy.pagNav([$bizproc, $workflow, $instances], param);
+        return this.Navvy.pagNav(this.url.instances, param);
     }
     /**
-     * Останавливает активный бизнес-процесс с сохранением его данных
+     * Прерывает активный бизнес-процесс с сохранением его данных.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-terminate.html
      */
     terminate(param) {
-        return this.Navvy.simple([$bizproc, $workflow, $terminate], param);
+        return this.Navvy.simple(this.url.terminate, param);
     }
     /**
-     * Удаляет запущенный бизнес-процесс вместе со всеми его данными
+     * Удаляет запущенный бизнес-процесс вместе со всеми его данными.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-kill.html
      */
     kill(param) {
-        return this.Navvy.simple([$bizproc, $workflow, $kill], param);
+        return this.Navvy.simple(this.url.kill, param);
+    }
+}
+
+/** Действия бизнес-процессов приложения (`bizproc.activity.*`). */
+class BXRestNavvyBizProcActivity {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Регистрирует новое действие. */
+            add: [$bizproc, $activity, $add],
+            /** Обновляет зарегистрированное действие. */
+            update: [$bizproc, $activity, $update],
+            /** Возвращает коды действий приложения. */
+            list: [$bizproc, $activity, $list],
+            /** Записывает сообщение в журнал бизнес-процесса. */
+            log: [$bizproc, $activity, $log],
+            /** Удаляет зарегистрированное действие. */
+            delete: [$bizproc, $activity, $delete]
+        };
+    }
+    /**
+     * Регистрирует новое действие бизнес-процесса для текущего приложения.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-add.html
+     */
+    add(param) {
+        return this.Navvy.simple(this.url.add, param);
+    }
+    /**
+     * Обновляет поля зарегистрированного действия.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-update.html
+     */
+    update(param) {
+        return this.Navvy.simple(this.url.update, param);
+    }
+    /**
+     * Возвращает список символьных кодов действий текущего приложения.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-list.html
+     */
+    list() {
+        return this.Navvy.simple(this.url.list);
+    }
+    /**
+     * Записывает сообщение в журнал бизнес-процесса.
+     *
+     * Регистрация действия должна содержать `USE_SUBSCRIPTION: 'Y'`, а токен
+     * события должен оставаться актуальным.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-log.html
+     */
+    log(param) {
+        return this.Navvy.simple(this.url.log, param);
+    }
+    /**
+     * Удаляет действие, зарегистрированное текущим приложением.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+}
+
+/** События действий и роботов (`bizproc.event.*`). */
+class BXRestNavvyBizProcEvent {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Возвращает выходные значения действию или роботу. */
+            send: [$bizproc, $event, $send]
+        };
+    }
+    /**
+     * Возвращает выходные значения действию или роботу и завершает ожидание.
+     *
+     * Регистрация должна содержать `USE_SUBSCRIPTION: 'Y'`, а переданный
+     * `EVENT_TOKEN` должен оставаться актуальным.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-event-send.html
+     */
+    send(param) {
+        return this.Navvy.simple(this.url.send, param);
     }
 }
 
+/** Роботы приложения (`bizproc.robot.*`). */
+class BXRestNavvyBizProcRobot {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Регистрирует нового робота. */
+            add: [$bizproc, $robot, $add],
+            /** Обновляет зарегистрированного робота. */
+            update: [$bizproc, $robot, $update],
+            /** Возвращает коды роботов приложения. */
+            list: [$bizproc, $robot, $list],
+            /** Удаляет зарегистрированного робота. */
+            delete: [$bizproc, $robot, $delete]
+        };
+    }
+    /**
+     * Регистрирует нового робота для текущего приложения.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-add.html
+     */
+    add(param) {
+        return this.Navvy.simple(this.url.add, param);
+    }
+    /**
+     * Обновляет поля зарегистрированного робота.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-update.html
+     */
+    update(param) {
+        return this.Navvy.simple(this.url.update, param);
+    }
+    /**
+     * Возвращает список символьных кодов роботов текущего приложения.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-list.html
+     */
+    list() {
+        return this.Navvy.simple(this.url.list);
+    }
+    /**
+     * Удаляет робота, зарегистрированного текущим приложением.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+}
+
+/** Бизнес-процессы, задания, действия и роботы (`bizproc.*`). */
 class BXRestNavvyBizProc {
     constructor() {
+        /** Задания бизнес-процессов. */
         this.task = new BXRestNavvyBizProcTask();
+        /** Запущенные бизнес-процессы и их шаблоны. */
         this.workflow = new BXRestNavvyBXRestBizProcWorkflow();
+        /** Действия бизнес-процессов, зарегистрированные приложением. */
+        this.activity = new BXRestNavvyBizProcActivity();
+        /** Роботы, зарегистрированные приложением. */
+        this.robot = new BXRestNavvyBizProcRobot();
+        /** Возврат результатов действиям и роботам. */
+        this.event = new BXRestNavvyBizProcEvent();
         this.BXRestNavvyLists = new BXRestNavvyLists();
     }
     /**
@@ -8672,6 +8913,131 @@ class BXRestNavvyCrm {
     }
 }
 
+/** Очередь офлайн-событий (`event.offline.*`). Доступна администраторам. */
+class BXRestNavvyEventOffline {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Возвращает и удаляет либо резервирует первые записи очереди. */
+            get: [$event, $offline, $get],
+            /** Возвращает страницу очереди, не меняя состояние записей. */
+            list: [$event, $offline, $list],
+            /** Удаляет обработанные записи зарезервированного пакета. */
+            clear: [$event, $offline, $clear],
+            /** Помечает записи зарезервированного пакета ошибочными. */
+            error: [$event, $offline, $error]
+        };
+    }
+    /**
+     * Возвращает первые записи очереди согласно фильтру.
+     *
+     * По умолчанию метод удаляет выбранные записи. Передайте `clear: 0`, чтобы
+     * зарезервировать их и получить `process_id` для последующего вызова
+     * `clear` или `error`. Параллельные запросы получают разные наборы записей.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/event-offline-get.html
+     */
+    get(param = {}) {
+        return this.Navvy.simple(this.url.get, param);
+    }
+    /**
+     * Читает одну страницу текущей очереди, не меняя состояние записей.
+     *
+     * Метод не резервирует записи и не формирует `process_id`. Размер страницы
+     * фиксирован и равен 50 записям.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/event-offline-list.html
+     */
+    list(param = {}) {
+        return this.Navvy.pagNav(this.url.list, param);
+    }
+    /**
+     * Удаляет обработанные записи зарезервированного пакета.
+     *
+     * Без `id` и `message_id` удаляет все записи с переданным `process_id`.
+     * Если указаны оба массива, `id` имеет приоритет.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/event-offline-clear.html
+     */
+    clear(param) {
+        return this.Navvy.simple(this.url.clear, param);
+    }
+    /**
+     * Помечает записи зарезервированного пакета ошибочными.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/event-offline-error.html
+     */
+    error(param) {
+        return this.Navvy.simple(this.url.error, param);
+    }
+}
+
+/** Регистрация обработчиков и работа с событиями Битрикс24. */
+class BXRestNavvyEvent {
+    constructor() {
+        this.Navvy = new Navvy();
+        /** Очередь офлайн-событий. Для вызовов требуются права администратора. */
+        this.offline = new BXRestNavvyEventOffline();
+        this.url = {
+            /** Регистрирует обработчик события. */
+            bind: [$event, $bind],
+            /** Возвращает зарегистрированные обработчики приложения. */
+            get: [$event, $get],
+            /** Удаляет зарегистрированный обработчик. */
+            unbind: [$event, $unbind],
+            /** Возвращает доступные текущему приложению события. */
+            events: [$events]
+        };
+    }
+    /**
+     * Регистрирует новый обработчик события.
+     *
+     * Метод работает только в контексте авторизации приложения. URL обработчика
+     * должен быть доступен серверам Битрикс24 извне. Пользователь без прав
+     * администратора может регистрировать только онлайн-события от своего имени.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/event-bind.html
+     */
+    bind(param) {
+        return this.Navvy.simple(this.url.bind, param);
+    }
+    /**
+     * Возвращает список зарегистрированных обработчиков событий.
+     *
+     * Пользователь без прав администратора получает только обработчики,
+     * зарегистрированные для него. Метод работает только в контексте авторизации
+     * приложения.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/event-get.html
+     */
+    get() {
+        return this.Navvy.simple(this.url.get);
+    }
+    /**
+     * Удаляет зарегистрированный обработчик события.
+     *
+     * Пользователь без прав администратора может удалять только собственные
+     * обработчики онлайн-событий.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/event-unbind.html
+     */
+    unbind(param) {
+        return this.Navvy.simple(this.url.unbind, param);
+    }
+    /**
+     * Возвращает общий список доступных событий.
+     *
+     * `SCOPE` ограничивает результат указанным разрешением. `FULL: true`
+     * запрашивает полный список, но игнорируется при одновременной передаче
+     * `SCOPE`.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/events.html
+     */
+    events(param = {}) {
+        return this.Navvy.simple(this.url.events, param);
+    }
+}
+
 class BXRestNavvy {
     constructor() {
         this.user = new BXRestNavvyUser();
@@ -8691,6 +9057,8 @@ class BXRestNavvy {
         this.socialNetWork = new BXRestNavvySocialNetWork();
         this.pull = new BXRestNavvyPull();
         this.crm = new BXRestNavvyCrm();
+        /** Регистрация обработчиков и работа с онлайн- и офлайн-событиями. */
+        this.event = new BXRestNavvyEvent();
         this.Navvy = new Navvy();
         // public batch<T, C, M>(param: iBXRestNavvyParamBatch<T, C, M>) {
         //   const modifiedObject = Object.fromEntries(