bx-rest 0.11.0 → 0.11.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bx-rest",
-  "version": "0.11.0",
+  "version": "0.11.2",
   "description": "Bitrix24 REST API client and TypeScript SDK for Angular, Vue and browser apps",
   "keywords": [
     "bitrix",
@@ -68,12 +68,18 @@
     "./typification/calendar": {
       "types": "./typification/rest/calendar.d.ts"
     },
+    "./typification/common": {
+      "types": "./typification/rest/common.d.ts"
+    },
     "./typification/department": {
       "types": "./typification/rest/department.d.ts"
     },
     "./typification/disk": {
       "types": "./typification/rest/disk.d.ts"
     },
+    "./typification/event": {
+      "types": "./typification/rest/event.d.ts"
+    },
     "./typification/im": {
       "types": "./typification/rest/im.d.ts"
     },

package/request-navvy/access.d.ts

@@ -0,0 +1,12 @@
+import { iBXRestAccessNameResult, iBXRestParamAccessName } from '../typification/rest/common';
+/** Получение сведений о кодах доступа (`access.*`). */
+export declare class BXRestNavvyAccess {
+    private readonly Navvy;
+    /**
+     * Возвращает человекочитаемые названия переданных кодов доступа.
+     *
+     * Например, `{ ACCESS: ['G2', 'AU'] }` вернет описания прав для всех
+     * посетителей и всех авторизованных пользователей.
+     */
+    name(param: iBXRestParamAccessName): import("../services/navvy").NavvySimple<iBXRestAccessNameResult, iBXRestAccessNameResult, iBXRestParamAccessName | undefined>;
+}

package/request-navvy/app/option.d.ts

@@ -0,0 +1,19 @@
+import { iBXRestOptionGetResult, iBXRestParamAppOptionGet, iBXRestParamAppOptionSet } from '../../typification/rest/app';
+/** Общие настройки текущего приложения (`app.option.*`). */
+export declare class BXRestNavvyAppOption {
+    private readonly Navvy;
+    /**
+     * Сохраняет или обновляет общие настройки приложения.
+     *
+     * Метод работает только в контексте приложения и требует прав администратора.
+     * Пустой объект `options` приводит к ошибке `ArgumentNullException`.
+     */
+    set(param: iBXRestParamAppOptionSet): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamAppOptionSet | undefined>;
+    /**
+     * Возвращает одну настройку приложения или все настройки сразу.
+     *
+     * Если `option` не указан, возвращаются все свойства, сохраненные через
+     * `app.option.set`. Метод работает только в контексте приложения.
+     */
+    get(param?: iBXRestParamAppOptionGet): import("../../services/navvy").NavvySimple<iBXRestOptionGetResult, iBXRestOptionGetResult, iBXRestParamAppOptionGet | undefined>;
+}

package/request-navvy/app.d.ts

@@ -1,8 +1,16 @@
 import { iBXRestAppInfo, iBXRestAppInfoHttp } from '../typification/rest/app';
+import { BXRestNavvyAppOption } from './app/option';
+/** Информация и общие настройки текущего приложения (`app.*`). */
 export declare class BXRestNavvyApp {
     private readonly Navvy;
+    /** Общие настройки приложения. */
+    readonly option: BXRestNavvyAppOption;
     /**
-     * Показ информации о приложении. Метод поддерживает безопасный вызов
+     * Возвращает информацию о текущем приложении и лицензии портала.
+     *
+     * Метод не принимает параметров, работает только в контексте приложения и
+     * доступен любому пользователю. Результат содержит код, версию, статус,
+     * состояние оплаты и сведения о тарифе.
      */
     info(): import("../services/navvy").NavvySimple<iBXRestAppInfoHttp, iBXRestAppInfo, undefined>;
 }

package/request-navvy/event/offline.d.ts

@@ -0,0 +1,49 @@
+import { iBXRestEventOfflineGetResult, iBXRestEventOfflineListItem, iBXRestParamEventOfflineClear, iBXRestParamEventOfflineError, iBXRestParamEventOfflineGet, iBXRestParamEventOfflineList } from '../../typification/rest/event';
+/** Очередь офлайн-событий (`event.offline.*`). Доступна администраторам. */
+export declare class BXRestNavvyEventOffline {
+    private readonly Navvy;
+    readonly url: {
+        /** Возвращает и удаляет либо резервирует первые записи очереди. */
+        get: string[];
+        /** Возвращает страницу очереди, не меняя состояние записей. */
+        list: string[];
+        /** Удаляет обработанные записи зарезервированного пакета. */
+        clear: string[];
+        /** Помечает записи зарезервированного пакета ошибочными. */
+        error: string[];
+    };
+    /**
+     * Возвращает первые записи очереди согласно фильтру.
+     *
+     * По умолчанию метод удаляет выбранные записи. Передайте `clear: 0`, чтобы
+     * зарезервировать их и получить `process_id` для последующего вызова
+     * `clear` или `error`. Параллельные запросы получают разные наборы записей.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/event-offline-get.html
+     */
+    get(param?: iBXRestParamEventOfflineGet): import("../../services/navvy").NavvySimple<iBXRestEventOfflineGetResult, iBXRestEventOfflineGetResult, iBXRestParamEventOfflineGet | undefined>;
+    /**
+     * Читает одну страницу текущей очереди, не меняя состояние записей.
+     *
+     * Метод не резервирует записи и не формирует `process_id`. Размер страницы
+     * фиксирован и равен 50 записям.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/event-offline-list.html
+     */
+    list(param?: iBXRestParamEventOfflineList): import("../../services/navvy").NavvyPag<iBXRestEventOfflineListItem, iBXRestEventOfflineListItem, iBXRestParamEventOfflineList>;
+    /**
+     * Удаляет обработанные записи зарезервированного пакета.
+     *
+     * Без `id` и `message_id` удаляет все записи с переданным `process_id`.
+     * Если указаны оба массива, `id` имеет приоритет.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/event-offline-clear.html
+     */
+    clear(param: iBXRestParamEventOfflineClear): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamEventOfflineClear | undefined>;
+    /**
+     * Помечает записи зарезервированного пакета ошибочными.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/event-offline-error.html
+     */
+    error(param: iBXRestParamEventOfflineError): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamEventOfflineError | undefined>;
+}

package/request-navvy/event.d.ts

@@ -0,0 +1,57 @@
+import { iBXRestEventHandler, iBXRestEventUnbindResult, iBXRestParamEventBind, iBXRestParamEventUnbind, iBXRestParamEvents } from '../typification/rest/event';
+import { BXRestNavvyEventOffline } from './event/offline';
+/** Регистрация обработчиков и работа с событиями Битрикс24. */
+export declare class BXRestNavvyEvent {
+    private readonly Navvy;
+    /** Очередь офлайн-событий. Для вызовов требуются права администратора. */
+    readonly offline: BXRestNavvyEventOffline;
+    readonly url: {
+        /** Регистрирует обработчик события. */
+        bind: string[];
+        /** Возвращает зарегистрированные обработчики приложения. */
+        get: string[];
+        /** Удаляет зарегистрированный обработчик. */
+        unbind: string[];
+        /** Возвращает доступные текущему приложению события. */
+        events: string[];
+    };
+    /**
+     * Регистрирует новый обработчик события.
+     *
+     * Метод работает только в контексте авторизации приложения. URL обработчика
+     * должен быть доступен серверам Битрикс24 извне. Пользователь без прав
+     * администратора может регистрировать только онлайн-события от своего имени.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/event-bind.html
+     */
+    bind(param: iBXRestParamEventBind): import("../services/navvy").NavvySimple<boolean, boolean, iBXRestParamEventBind | undefined>;
+    /**
+     * Возвращает список зарегистрированных обработчиков событий.
+     *
+     * Пользователь без прав администратора получает только обработчики,
+     * зарегистрированные для него. Метод работает только в контексте авторизации
+     * приложения.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/event-get.html
+     */
+    get(): import("../services/navvy").NavvySimple<iBXRestEventHandler[], iBXRestEventHandler[], undefined>;
+    /**
+     * Удаляет зарегистрированный обработчик события.
+     *
+     * Пользователь без прав администратора может удалять только собственные
+     * обработчики онлайн-событий.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/event-unbind.html
+     */
+    unbind(param: iBXRestParamEventUnbind): import("../services/navvy").NavvySimple<iBXRestEventUnbindResult, iBXRestEventUnbindResult, iBXRestParamEventUnbind | undefined>;
+    /**
+     * Возвращает общий список доступных событий.
+     *
+     * `SCOPE` ограничивает результат указанным разрешением. `FULL: true`
+     * запрашивает полный список, но игнорируется при одновременной передаче
+     * `SCOPE`.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/events/events.html
+     */
+    events(param?: iBXRestParamEvents): import("../services/navvy").NavvySimple<string[], string[], iBXRestParamEvents | undefined>;
+}

package/request-navvy/feature.d.ts

@@ -0,0 +1,12 @@
+import { iBXRestFeatureAvailability, iBXRestParamFeatureGet } from '../typification/rest/common';
+/** Проверка доступности возможностей портала (`feature.*`). */
+export declare class BXRestNavvyFeature {
+    private readonly Navvy;
+    /**
+     * Проверяет доступность указанной возможности на текущем портале.
+     *
+     * Поддерживаемые коды: `rest_offline_extended` и `rest_auth_connector`.
+     * В поле `value` сервер возвращает `Y` или `N`.
+     */
+    get(param: iBXRestParamFeatureGet): import("../services/navvy").NavvySimple<iBXRestFeatureAvailability, iBXRestFeatureAvailability, iBXRestParamFeatureGet | undefined>;
+}

package/request-navvy/method.d.ts

@@ -0,0 +1,11 @@
+import { iBXRestMethodAvailability, iBXRestParamMethodGet } from '../typification/rest/common';
+/** Проверка существования и доступности REST-методов (`method.*`). */
+export declare class BXRestNavvyMethod {
+    private readonly Navvy;
+    /**
+     * Проверяет, существует ли метод на портале и доступен ли он приложению.
+     *
+     * Передавайте имя метода в нижнем регистре, например `{ name: 'user.get' }`.
+     */
+    get(param: iBXRestParamMethodGet): import("../services/navvy").NavvySimple<iBXRestMethodAvailability, iBXRestMethodAvailability, iBXRestParamMethodGet | undefined>;
+}

package/request-navvy/server.d.ts

@@ -3,5 +3,12 @@ export declare class BXRestNavvyServer {
         time: string[];
     };
     private readonly Navvy;
+    /**
+     * Возвращает текущее время сервера как объект `Date`.
+     *
+     * Исходный ответ REST API имеет формат ISO 8601
+     * `YYYY-MM-DDThh:mm:ss±hh:mm`; получить его без преобразования можно через
+     * `resVanilla()` у возвращаемого навигатора.
+     */
     time(): import("../services/navvy").NavvySimple<string, Date, undefined>;
 }

package/request-navvy/user/option.d.ts

@@ -0,0 +1,20 @@
+import { iBXRestOptionGetResult } from '../../typification/rest/app';
+import { iBXRestParamUserOptionGet, iBXRestParamUserOptionSet } from '../../typification/rest/user';
+/** Персональные настройки текущего пользователя (`user.option.*`). */
+export declare class BXRestNavvyUserOption {
+    private readonly Navvy;
+    /**
+     * Сохраняет или обновляет настройки текущего пользователя для приложения.
+     *
+     * Метод работает только в контексте приложения. Пустой объект `options`
+     * приводит к ошибке `ArgumentNullException`.
+     */
+    set(param: iBXRestParamUserOptionSet): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamUserOptionSet | undefined>;
+    /**
+     * Возвращает одну пользовательскую настройку или все настройки сразу.
+     *
+     * Если `option` не указан, возвращаются все свойства, сохраненные через
+     * `user.option.set`. Метод работает только в контексте приложения.
+     */
+    get(param?: iBXRestParamUserOptionGet): import("../../services/navvy").NavvySimple<iBXRestOptionGetResult, iBXRestOptionGetResult, iBXRestParamUserOptionGet | undefined>;
+}

package/request-navvy/user.d.ts

@@ -1,5 +1,6 @@
-import { iBXRestParamUserGet, iBXRestParamUserSearch, iBXRestUser, iBXRestUserHttp, iBXRestUserHttpField } from '../typification/rest/user';
+import { iBXRestParamUserGet, iBXRestParamUserAccess, iBXRestParamUserSearch, iBXRestUser, iBXRestUserHttp, iBXRestUserHttpField } from '../typification/rest/user';
 import { BXRestNavvyUserUserfield } from './user/userfield';
+import { BXRestNavvyUserOption } from './user/option';
 export declare class BXRestNavvyUser {
     def: {
         params: {
@@ -17,12 +18,26 @@ export declare class BXRestNavvyUser {
         fields: string[];
     };
     readonly userField: BXRestNavvyUserUserfield;
+    /** Персональные настройки текущего пользователя для приложения. */
+    readonly option: BXRestNavvyUserOption;
     private readonly Navvy;
+    /**
+     * Проверяет, может ли текущий пользователь управлять настройками приложений.
+     *
+     * Возвращает `true` для пользователя с соответствующими административными
+     * правами и `false` в остальных случаях.
+     */
     admin(): import("../services/navvy").NavvySimple<boolean, boolean, undefined>;
     get(params?: iBXRestParamUserGet): import("../services/navvy").NavvyPag<iBXRestUserHttp, iBXRestUser, iBXRestParamUserGet>;
     current(): import("../services/navvy").NavvySimple<iBXRestUserHttp, iBXRestUser, undefined>;
     search(params: iBXRestParamUserSearch): import("../services/navvy").NavvyPag<iBXRestUserHttp, iBXRestUser, iBXRestParamUserSearch>;
-    access(params: string[]): import("../services/navvy").NavvySimple<boolean, boolean, string[] | undefined>;
+    /**
+     * Проверяет наличие хотя бы одного из указанных кодов доступа.
+     *
+     * Для обратной совместимости можно передать как объект
+     * `{ ACCESS: ['G2', 'AU'] }`, так и непосредственно массив кодов.
+     */
+    access(params: iBXRestParamUserAccess | string[]): import("../services/navvy").NavvySimple<boolean, boolean, iBXRestParamUserAccess | undefined>;
     fields(): import("../services/navvy").NavvySimple<iBXRestUserHttpField, iBXRestUserHttpField, undefined>;
     private setDefParam;
 }

package/rest/navvy.d.ts

@@ -16,7 +16,12 @@ import { BXRestNavvyTimeMan } from '../request-navvy/timeman';
 import { BXRestNavvySocialNetWork } from '../request-navvy/socialnetwork';
 import { BXRestNavvyPull } from '../request-navvy/pull';
 import { BXRestNavvyCrm } from '../request-navvy/crm';
+import { BXRestNavvyEvent } from '../request-navvy/event';
 import { iBXRestProfile, iBXRestProfileHttp } from '../typification/rest/profile';
+import { BXRestNavvyMethod } from '../request-navvy/method';
+import { BXRestNavvyAccess } from '../request-navvy/access';
+import { BXRestNavvyFeature } from '../request-navvy/feature';
+import { iBXRestParamScope } from '../typification/rest/common';
 export declare class BXRestNavvy {
     readonly user: BXRestNavvyUser;
     readonly lists: BXRestNavvyLists;
@@ -35,6 +40,27 @@ export declare class BXRestNavvy {
     readonly socialNetWork: BXRestNavvySocialNetWork;
     readonly pull: BXRestNavvyPull;
     readonly crm: BXRestNavvyCrm;
+    /** Регистрация обработчиков и работа с онлайн- и офлайн-событиями. */
+    readonly event: BXRestNavvyEvent;
+    /** Проверка существования и доступности REST-методов. */
+    readonly method: BXRestNavvyMethod;
+    /** Получение описаний кодов доступа. */
+    readonly access: BXRestNavvyAccess;
+    /** Проверка доступности возможностей портала. */
+    readonly feature: BXRestNavvyFeature;
     readonly Navvy: Navvy;
+    /**
+     * Возвращает базовую информацию о текущем пользователе без scope `user`.
+     *
+     * Результат содержит идентификатор, имя, фамилию, признак администратора,
+     * пол, часовой пояс и связанные поля профиля.
+     */
     profile(): import("../services/navvy").NavvySimple<iBXRestProfileHttp, iBXRestProfile, undefined>;
+    /**
+     * Возвращает разрешения текущего приложения.
+     *
+     * Передайте `{ full: true }`, чтобы запросить полный список разрешений
+     * портала. Без параметров возвращаются разрешения, доступные приложению.
+     */
+    scope(param?: iBXRestParamScope): import("../services/navvy").NavvySimple<string[], string[], iBXRestParamScope | undefined>;
 }

package/typification/rest/app/info.d.ts

@@ -1,17 +1,33 @@
 import { iBXRestYesNo } from '../base/yes-no';
 export interface iBXRestAppInfo extends iBXRestAppInfoBase {
+    /** Локальный идентификатор приложения на портале. */
     ID: number;
+    /** Истек ли оплаченный или пробный период. */
     PAYMENT_EXPIRED: boolean;
 }
 export interface iBXRestAppInfoHttp extends iBXRestAppInfoBase {
-    ID: string;
+    /** Локальный идентификатор приложения в исходном формате REST API. */
+    ID: string | number;
+    /** Признак окончания оплаченного или пробного периода. */
     PAYMENT_EXPIRED: iBXRestYesNo;
 }
 export interface iBXRestAppInfoBase {
-    VERSION: 1;
+    /** Код приложения. */
+    CODE: string;
+    /** Установленная версия приложения. */
+    VERSION: number;
+    /** Статус: бесплатное, демо, пробное, платное, локальное или подписное. */
     STATUS: 'F' | 'D' | 'T' | 'P' | 'L' | 'S';
+    /** Завершена ли установка приложения. */
     INSTALLED: boolean;
-    DAYS: null;
-    LICENSE: // Обозначение тарифа с указанием региона в виде префикса.Состоит из базового языка портала и идентификатора тарифного плана. В случае с тарифами, состав которых менялся при сохранении публичного наименования (как CRM+, Команда и Компания), понять, какой именно тариф действует по этому полю нельзя. Примеры вариантов значений:
-    'ru_project' | 'ru_basic' | 'ru_std' | 'ru_pro100' | 'ru_ent250' | 'ru_ent500' | 'ru_ent1000' | 'ru_ent2000' | 'ru_ent10000';
+    /** Количество дней до конца оплаченного или пробного периода. */
+    DAYS: number | null;
+    /** Базовый язык портала. */
+    LANGUAGE_ID: string;
+    /** Тариф с региональным префиксом, например `ru_ent10000`. */
+    LICENSE: string;
+    /** Идентификатор тарифного плана без регионального префикса. */
+    LICENSE_TYPE: string;
+    /** Семейство тарифного плана. */
+    LICENSE_FAMILY: string;
 }

package/typification/rest/app/option.d.ts

@@ -0,0 +1,18 @@
+/** Значение, которое можно сохранить в настройках приложения. */
+export type iBXRestOptionValue = string | number | boolean | null | iBXRestOptionValue[] | {
+    [key: string]: iBXRestOptionValue;
+};
+/** Набор именованных настроек приложения или пользователя. */
+export type iBXRestOptionValues = Record<string, iBXRestOptionValue>;
+/** Параметры `app.option.set`. */
+export interface iBXRestParamAppOptionSet {
+    /** Настройки: ключ — имя свойства, значение — сохраняемые данные. */
+    options: iBXRestOptionValues;
+}
+/** Параметры `app.option.get`. */
+export interface iBXRestParamAppOptionGet {
+    /** Имя свойства. Если не указано, метод вернет все настройки приложения. */
+    option?: string;
+}
+/** Результат чтения одной настройки или всего набора настроек. */
+export type iBXRestOptionGetResult = iBXRestOptionValue | iBXRestOptionValues;

package/typification/rest/app.d.ts

@@ -2,3 +2,4 @@
  * Файл для возможности импорта интерфейсов данного пакета в локальные проекты
  */
 export * from './app/info';
+export * from './app/option';

package/typification/rest/common.d.ts

@@ -0,0 +1,56 @@
+/** Параметры проверки REST-метода через `method.get`. */
+export interface iBXRestParamMethodGet {
+    /** Имя метода в нижнем регистре, например `user.get`. */
+    name: string;
+}
+/** Результат проверки REST-метода через `method.get`. */
+export interface iBXRestMethodAvailability {
+    /** Метод существует на портале. */
+    isExisting: boolean;
+    /** Метод доступен с текущими разрешениями приложения. */
+    isAvailable: boolean;
+}
+/** Параметры получения разрешений через `scope`. */
+export interface iBXRestParamScope {
+    /** Вернуть полный список разрешений портала, а не только разрешения приложения. */
+    full?: boolean;
+}
+/** Параметры получения названий кодов доступа через `access.name`. */
+export interface iBXRestParamAccessName {
+    /** Коды доступа, например `G2` и `AU`. */
+    ACCESS: string[];
+}
+/** Описание кода доступа, возвращаемое методом `access.name`. */
+export interface iBXRestAccessDescription {
+    /** Название поставщика права. */
+    provider: string;
+    /** Человекочитаемое название права. */
+    name: string;
+    /** Идентификатор поставщика права. */
+    provider_id: string;
+}
+/** Результат `access.name`, индексированный исходными кодами доступа. */
+export type iBXRestAccessNameResult = Record<string, iBXRestAccessDescription>;
+/** Поддерживаемые документацией коды `feature.get`. */
+export type iBXRestFeatureCode = 
+/** Доступность офлайн-событий. */
+'rest_offline_extended'
+/** Доступность ключа `auth_connector` в событиях. */
+ | 'rest_auth_connector';
+/** Параметры проверки функционала через `feature.get`. */
+export interface iBXRestParamFeatureGet {
+    /** Код проверяемой возможности портала. */
+    CODE: iBXRestFeatureCode;
+}
+/** Основной результат проверки функционала через `feature.get`. */
+export interface iBXRestFeatureAvailabilityBase {
+    /** Признак наличия функционала: `Y` — доступен, `N` — недоступен. */
+    value: 'Y' | 'N';
+}
+/**
+ * Результат проверки функционала через `feature.get`.
+ *
+ * Коробочная версия может дополнительно вернуть языковой флаг, например
+ * `ru_selfhosted`; `lang` в документации заменяется кодом языка портала.
+ */
+export type iBXRestFeatureAvailability = iBXRestFeatureAvailabilityBase & Partial<Record<`${string}_selfhosted`, 'Y' | 'N'>>;

package/typification/rest/event.d.ts

@@ -0,0 +1,178 @@
+import { iBXRestPagination } from './base/api-pagination-bx';
+import { iBXRestFilterKeys } from './base/filter-generator';
+/** Режим доставки события. */
+export type iBXRestEventType = 'online' | 'offline';
+/** Дополнительные настройки обработчика события. */
+export interface iBXRestEventBindOptions {
+    /**
+     * Минимальный интервал между уведомлениями `ONOFFLINEEVENT` в секундах.
+     *
+     * Если не указан, Битрикс24 использует интервал в одну секунду.
+     */
+    minTimeout?: number;
+    /** Дополнительные настройки, поддерживаемые конкретным событием. */
+    [key: string]: unknown;
+}
+/** Параметры `event.bind`. */
+export interface iBXRestParamEventBind {
+    /** Имя события, например `ONCRMLEADADD`. */
+    event: string;
+    /** Внешний URL обработчика, доступный серверам Битрикс24. */
+    handler: string;
+    /**
+     * Идентификатор пользователя, под которым авторизуется обработчик.
+     *
+     * Если не указан, используется авторизация пользователя, действие которого
+     * привело к событию.
+     */
+    auth_type?: number;
+    /** Режим доставки. По умолчанию — `online`. */
+    event_type?: iBXRestEventType;
+    /**
+     * Ключ источника для офлайн-событий.
+     *
+     * Позволяет разделять очередь по источникам и исключать ложные срабатывания.
+     */
+    auth_connector?: string;
+    /** Дополнительные настройки регистрируемого события. */
+    options?: iBXRestEventBindOptions;
+}
+/** Зарегистрированный обработчик, возвращаемый `event.get`. */
+export interface iBXRestEventHandler {
+    /** Имя события. */
+    event: string;
+    /** URL обработчика. */
+    handler: string;
+    /** Идентификатор пользователя авторизации в исходном формате REST API. */
+    auth_type: string;
+    /** Признак офлайн-обработчика: `1` — офлайн, `0` — онлайн. */
+    offline: 0 | 1;
+}
+/** Параметры `event.unbind`. */
+export interface iBXRestParamEventUnbind {
+    /** Имя события. */
+    event: string;
+    /** URL обработчика события. */
+    handler: string;
+    /**
+     * Идентификатор пользователя авторизации.
+     *
+     * Передайте `0`, чтобы удалить обработчики с пустым `auth_type`, не затрагивая
+     * обработчики, зарегистрированные для конкретных пользователей.
+     */
+    auth_type?: number;
+    /** Режим доставки. По умолчанию — `online`. */
+    event_type?: iBXRestEventType;
+}
+/** Результат удаления обработчиков методом `event.unbind`. */
+export interface iBXRestEventUnbindResult {
+    /** Количество удаленных обработчиков. */
+    count: number;
+}
+/** Параметры получения общего списка доступных событий методом `events`. */
+export interface iBXRestParamEvents {
+    /** Разрешение, которому должны принадлежать возвращаемые события. */
+    SCOPE?: string;
+    /**
+     * Вернуть полный список событий.
+     *
+     * Игнорируется, если одновременно передан `SCOPE`.
+     */
+    FULL?: boolean;
+}
+/** Поле записи очереди, доступное для фильтрации и сортировки. */
+export type iBXRestEventOfflineField = 'ID' | 'TIMESTAMP_X' | 'EVENT_NAME' | 'MESSAGE_ID' | 'PROCESS_ID' | 'ERROR';
+/** Значение фильтра очереди офлайн-событий. */
+export type iBXRestEventOfflineFilterValue = string | number | boolean | (string | number | boolean)[];
+/**
+ * Фильтр очереди офлайн-событий.
+ *
+ * Операция указывается перед именем поля, например `=EVENT_NAME` или `>=ID`.
+ */
+export type iBXRestEventOfflineFilter = Partial<Record<`${iBXRestFilterKeys}${iBXRestEventOfflineField}`, iBXRestEventOfflineFilterValue>>;
+/** Направление сортировки очереди офлайн-событий. */
+export type iBXRestEventOfflineSortOrder = 'ASC' | 'DESC';
+/** Сортировка очереди офлайн-событий. */
+export type iBXRestEventOfflineOrder = Partial<Record<iBXRestEventOfflineField, iBXRestEventOfflineSortOrder>>;
+/** Общие параметры выборки очереди офлайн-событий. */
+export interface iBXRestParamEventOfflineSelection {
+    /** Фильтр по полям записи очереди. */
+    filter?: iBXRestEventOfflineFilter;
+    /** Сортировка по полям записи очереди. */
+    order?: iBXRestEventOfflineOrder;
+    /**
+     * Ключ источника.
+     *
+     * Должен совпадать с `auth_connector`, переданным при подписке через
+     * `event.bind`.
+     */
+    auth_connector?: string;
+}
+/** Параметры `event.offline.get`. */
+export interface iBXRestParamEventOfflineGet extends iBXRestParamEventOfflineSelection {
+    /** Максимальное количество записей. По умолчанию — `50`. */
+    limit?: number;
+    /** Удалять выбранные записи: `1` — да, `0` — зарезервировать. По умолчанию — `1`. */
+    clear?: 0 | 1;
+    /** Идентификатор процесса для повторного получения необработанных им записей. */
+    process_id?: string;
+    /** Возвращать записи, помеченные ошибочными. По умолчанию — `0`. */
+    error?: 0 | 1;
+}
+/** Параметры `event.offline.list`. */
+export interface iBXRestParamEventOfflineList extends iBXRestParamEventOfflineSelection, iBXRestPagination {
+}
+/** Запись очереди офлайн-событий. */
+export interface iBXRestEventOfflineItem {
+    /** Идентификатор записи. */
+    ID: string;
+    /** Дата и время создания записи в формате ISO 8601. */
+    TIMESTAMP_X: string;
+    /** Имя события. */
+    EVENT_NAME: string;
+    /** Данные события в исходном формате REST API. */
+    EVENT_DATA: unknown;
+    /** Дополнительные данные события в исходном формате REST API. */
+    EVENT_ADDITIONAL: unknown;
+    /** Идентификатор сообщения. */
+    MESSAGE_ID: string;
+}
+/** Запись, возвращаемая методом `event.offline.list`. */
+export interface iBXRestEventOfflineListItem extends iBXRestEventOfflineItem {
+    /** Идентификатор процесса, зарезервировавшего запись; пустая строка, если запись свободна. */
+    PROCESS_ID: string;
+    /** Признак ошибки обработки в исходном формате REST API. */
+    ERROR: '0' | '1';
+}
+/** Результат `event.offline.get`. */
+export interface iBXRestEventOfflineGetResult {
+    /**
+     * Идентификатор зарезервированного пакета.
+     *
+     * Возвращается при `clear: 0`; при немедленной очистке имеет значение `null`.
+     */
+    process_id: string | null;
+    /** Выбранные записи очереди. */
+    events: iBXRestEventOfflineItem[];
+}
+/** Параметры `event.offline.clear`. */
+export interface iBXRestParamEventOfflineClear {
+    /** Идентификатор пакета, полученный от `event.offline.get` при `clear: 0`. */
+    process_id: string;
+    /**
+     * Идентификаторы записей для удаления.
+     *
+     * Если не указаны, удаляются все записи пакета. Имеют приоритет над
+     * `message_id`.
+     */
+    id?: (string | number)[];
+    /** Значения `MESSAGE_ID` удаляемых записей. */
+    message_id?: (string | number)[];
+}
+/** Параметры `event.offline.error`. */
+export interface iBXRestParamEventOfflineError {
+    /** Идентификатор процесса, обрабатывающего записи. */
+    process_id: string;
+    /** Значения `MESSAGE_ID` записей, которые нужно пометить ошибочными. */
+    message_id?: (string | number)[];
+}