bx-rest 0.10.7 → 0.11.1

package/typification/rest/bizproc/workflow/template/list.d.ts

@@ -1,8 +1,34 @@
+import { iBXRestPagination } from '../../../base/api-pagination-bx';
+import { iBXRestFilterGenerator } from '../../../base/filter-generator';
+import { iBXRestParamSort } from '../../../base/sort';
+import { iBXRestYesNo } from '../../../base/yes-no';
 import { iRestBXBizprocWorkflowTemplateFieldEnum } from '../../base/filedEnum';
-export interface iBXRestParamBizprocWorkflowTemplateList {
-    select: iRestBXBizprocWorkflowTemplateFieldEnum[];
-    filter: iBXRestParamBizprocWorkflowTemplateListFilter;
+import { iBXRestBizprocWorkflowTemplateAutoExecute } from './add';
+/** Параметры `bizproc.workflow.template.list`. */
+export interface iBXRestParamBizprocWorkflowTemplateList extends iBXRestPagination {
+    /** Поля результата; по умолчанию возвращается только `ID`. */
+    select?: iRestBXBizprocWorkflowTemplateFieldEnum[];
+    /** Фильтр по полям шаблона. */
+    filter?: iBXRestParamBizprocWorkflowTemplateListFilter;
+    /** Сортировка; по умолчанию `{ ID: 'ASC' }`. */
+    order?: Partial<Record<iRestBXBizprocWorkflowTemplateFieldEnum, iBXRestParamSort>>;
+}
+/** Фильтр списка шаблонов с поддержкой операторов сравнения. */
+export type iBXRestParamBizprocWorkflowTemplateListFilter = iBXRestFilterGenerator<Partial<Record<iRestBXBizprocWorkflowTemplateFieldEnum, unknown>>>;
+/** Шаблон бизнес-процесса, возвращаемый методом списка. */
+export interface iBXRestBizprocWorkflowTemplate {
+    ID?: string;
+    MODULE_ID?: string;
+    ENTITY?: string;
+    DOCUMENT_TYPE?: string;
+    AUTO_EXECUTE?: iBXRestBizprocWorkflowTemplateAutoExecute;
+    NAME?: string;
+    TEMPLATE?: unknown[];
+    PARAMETERS?: unknown[];
+    VARIABLES?: unknown[];
+    CONSTANTS?: unknown[];
+    MODIFIED?: string;
+    IS_MODIFIED?: iBXRestYesNo;
+    USER_ID?: string;
+    SYSTEM_CODE?: string;
 }
-export type iBXRestParamBizprocWorkflowTemplateListFilter = {
-    [Property in iRestBXBizprocWorkflowTemplateFieldEnum]?: any;
-};

package/typification/rest/bizproc/workflow/template/update.d.ts

@@ -0,0 +1,19 @@
+import { iBXRestBizprocWorkflowTemplateAutoExecute, iBXRestBizprocWorkflowTemplateFile } from './add';
+/** Изменяемые поля шаблона бизнес-процесса. */
+export interface iBXRestBizprocWorkflowTemplateUpdateFields {
+    /** Новое название шаблона. */
+    NAME?: string;
+    /** Новое описание шаблона. */
+    DESCRIPTION?: string;
+    /** Новое содержимое файла `.bpt`. */
+    TEMPLATE_DATA?: iBXRestBizprocWorkflowTemplateFile;
+    /** Новый режим автозапуска. */
+    AUTO_EXECUTE?: iBXRestBizprocWorkflowTemplateAutoExecute;
+}
+/** Параметры `bizproc.workflow.template.update`. */
+export interface iBXRestParamBizprocWorkflowTemplateUpdate {
+    /** Идентификатор шаблона. */
+    ID: number | string;
+    /** Поля, которые необходимо обновить. */
+    FIELDS: iBXRestBizprocWorkflowTemplateUpdateFields;
+}

package/typification/rest/bizproc/workflow/terminate.d.ts

@@ -1,4 +1,7 @@
+/** Параметры `bizproc.workflow.terminate`. */
 export interface iBXRestParamBizprocWorkflowTerminate {
+    /** Идентификатор запущенного бизнес-процесса. */
     ID: string;
+    /** Текст статуса, который будет установлен при остановке. */
     STATUS?: string;
 }

package/typification/rest/bizproc.d.ts

@@ -2,6 +2,10 @@
  * Файл для возможности импорта интерфейсов данного пакета в локальные проекты
  */
 export * from './bizproc/base/filedEnum';
+export * from './bizproc/base/registration';
+export * from './bizproc/activity';
+export * from './bizproc/event';
+export * from './bizproc/robot';
 export * from './bizproc/task/complete';
 export * from './bizproc/task/delegate';
 export * from './bizproc/task/list';
@@ -9,4 +13,7 @@ export * from './bizproc/workflow/instances';
 export * from './bizproc/workflow/kill';
 export * from './bizproc/workflow/start';
 export * from './bizproc/workflow/terminate';
+export * from './bizproc/workflow/template/add';
+export * from './bizproc/workflow/template/delete';
 export * from './bizproc/workflow/template/list';
+export * from './bizproc/workflow/template/update';

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)[];
+}

package/typification/rest/user/user.d.ts

@@ -17,39 +17,39 @@ interface iBXRestUserBase {
     ACTIVE: boolean;
     EMAIL: string;
     NAME: string;
-    LAST_NAME: string;
-    SECOND_NAME: string;
-    PERSONAL_GENDER: iAllBXGender;
-    PERSONAL_PROFESSION: string;
-    PERSONAL_WWW: string;
+    LAST_NAME: string | null;
+    SECOND_NAME: string | null;
+    PERSONAL_GENDER?: iAllBXGender;
+    PERSONAL_PROFESSION?: string;
+    PERSONAL_WWW?: string;
     PERSONAL_BIRTHDAY: string | Date;
-    PERSONAL_PHOTO: string;
-    PERSONAL_ICQ: string;
-    PERSONAL_PHONE: string;
-    PERSONAL_FAX: string;
-    PERSONAL_MOBILE: string;
-    PERSONAL_PAGER: string;
-    PERSONAL_STREET: string;
-    PERSONAL_CITY: string;
-    PERSONAL_STATE: string;
-    PERSONAL_ZIP: string;
-    PERSONAL_COUNTRY: string;
-    TIME_ZONE: string;
-    TIME_ZONE_OFFSET: string;
-    WORK_COMPANY: string;
-    WORK_POSITION: string;
-    WORK_PHONE: string;
-    UF_DEPARTMENT: number[];
-    UF_INTERESTS: string;
-    UF_SKILLS: string;
-    UF_WEB_SITES: string;
-    UF_XING: string;
-    UF_LINKEDIN: string;
-    UF_FACEBOOK: string;
-    UF_TWITTER: string;
-    UF_SKYPE: string;
-    UF_DISTRICT: string;
-    UF_PHONE_INNER: string;
+    PERSONAL_PHOTO: string | null;
+    PERSONAL_ICQ: string | null;
+    PERSONAL_PHONE: string | null;
+    PERSONAL_FAX: string | null;
+    PERSONAL_MOBILE: string | null;
+    PERSONAL_PAGER: string | null;
+    PERSONAL_STREET: string | null;
+    PERSONAL_CITY: string | null;
+    PERSONAL_STATE: string | null;
+    PERSONAL_ZIP: string | null;
+    PERSONAL_COUNTRY: string | null;
+    TIME_ZONE?: string;
+    TIME_ZONE_OFFSET?: string;
+    WORK_COMPANY?: string;
+    WORK_POSITION: string | null;
+    WORK_PHONE?: string;
+    UF_DEPARTMENT: number[] | null;
+    UF_INTERESTS?: string | null;
+    UF_SKILLS?: string | null;
+    UF_WEB_SITES?: string | null;
+    UF_XING?: string | null;
+    UF_LINKEDIN?: string | null;
+    UF_FACEBOOK?: string | null;
+    UF_TWITTER?: string | null;
+    UF_SKYPE?: string | null;
+    UF_DISTRICT?: string | null;
+    UF_PHONE_INNER?: string | null;
     [keys: string]: any;
 }
 export type iAllBXGender = 'M' | 'F' | '';