bx-rest 0.10.3 → 0.10.5

package/typification/rest/department/update.d.ts

@@ -1,7 +0,0 @@
-export interface iBXRestDepartmentUpdate {
-    ID: number;
-    NAME: string;
-    SORT?: number;
-    PARENT?: number;
-    UF_HEAD?: number;
-}

package/typification/rest/department.d.ts

@@ -1,8 +0,0 @@
-/**
- * Файл для возможности импорта интерфейсов подразделений в локальные проекты
- */
-export * from './department/add';
-export * from './department/del';
-export * from './department/department';
-export * from './department/get';
-export * from './department/update';

package/typification/rest/disk/AttachedObject.d.ts

@@ -1,26 +0,0 @@
-export interface iBXRestParamRestDiskAttachedObject {
-    id: number;
-}
-export interface iBXRestDiskAttachedObject extends iBXRestDiskAttachedObjectBase {
-    ID: number;
-    OBJECT_ID: number;
-    ENTITY_ID: number;
-    CREATE_TIME: Date;
-    CREATED_BY: number;
-    SIZE: number;
-}
-export interface iBXRestDiskAttachedObjectHttp extends iBXRestDiskAttachedObjectBase {
-    ID: string;
-    OBJECT_ID: string;
-    ENTITY_ID: string;
-    CREATE_TIME: string;
-    CREATED_BY: string;
-    SIZE: string;
-}
-interface iBXRestDiskAttachedObjectBase {
-    MODULE_ID: string;
-    ENTITY_TYPE: string;
-    DOWNLOAD_URL: string;
-    NAME: string;
-}
-export {};

package/typification/rest/disk/file.d.ts

@@ -1,19 +0,0 @@
-import { iBXRestFolderOrFile, iBXRestFolderOrFileBase } from './folder';
-export type iBXRestParamDiskFileMarkDeleted = iBXRestParamDiskFile;
-export type iBXRestParamDiskFileGet = iBXRestParamDiskFile;
-export interface iBXRestParamDiskFile {
-    id: number;
-}
-export interface iBXRestDiskFile extends iBXRestFolderOrFile, iBXRestDiskFileBase {
-    SIZE: number;
-    FILE_ID: number;
-}
-export interface iBXRestDiskFileHttp extends iBXRestFolderOrFile, iBXRestDiskFileBase {
-    SIZE: string;
-    FILE_ID: string;
-}
-export interface iBXRestDiskFileBase extends iBXRestFolderOrFileBase {
-    DOWNLOAD_URL: string;
-    GLOBAL_CONTENT_VERSION: number;
-    TYPE: 'file';
-}

package/typification/rest/disk/folder/addSubFolder.d.ts

@@ -1,6 +0,0 @@
-export interface iBXRestDiskFolderAddSubFolderParam {
-    id: number;
-    data: {
-        NAME: string;
-    };
-}

package/typification/rest/disk/folder/copyTo.d.ts

@@ -1,4 +0,0 @@
-export interface iBXRestDiskFolderCopyToParam {
-    id: number;
-    targetFolderId: number;
-}

package/typification/rest/disk/folder/getFields.d.ts

@@ -1,9 +0,0 @@
-import { iBXRestFolder } from '../folder';
-export type iBXRestDiskFolderGetFieldsHttp = {
-    [key in keyof iBXRestFolder]: iBXRestDiskFolderGetFieldsHttpElement;
-};
-export interface iBXRestDiskFolderGetFieldsHttpElement {
-    TYPE: 'integer' | 'string' | 'enum' | 'datetime';
-    USE_IN_FILTER: boolean;
-    USE_IN_SHOW: boolean;
-}

package/typification/rest/disk/folder/moveTo.d.ts

@@ -1,4 +0,0 @@
-export interface iBXRestDiskFolderMoveToParam {
-    id: number;
-    targetFolderId: number;
-}

package/typification/rest/disk/folder/rename.d.ts

@@ -1,4 +0,0 @@
-export interface iBXRestDiskFolderRenameParam {
-    id: number;
-    newName: string;
-}

package/typification/rest/disk/folder/uploadFile.d.ts

@@ -1,13 +0,0 @@
-export interface iBXRestDiskFolderUploadFileParam {
-    id: number;
-    fileContent: string;
-    data: {
-        NAME: string;
-    };
-    generateUniqueName?: boolean;
-    rights?: [];
-}
-export interface iBXRestDiskFolderUploadFileParamRights {
-    TASK_ID: number;
-    ACCESS_CODE: string;
-}

package/typification/rest/disk/folder.d.ts

@@ -1,62 +0,0 @@
-export interface iBXRestParamFolderGet extends iBXRestParamFolder {
-}
-export interface iBXRestParamFolderDeleteTree extends iBXRestParamFolder {
-}
-export interface iBXRestParamFolderMarkDeleted extends iBXRestParamFolder {
-}
-export interface iBXRestParamFolderRestore extends iBXRestParamFolder {
-}
-export interface iBXRestParamFolderGetExternalLink extends iBXRestParamFolder {
-}
-export interface iBXRestParamFolderGetChildren extends iBXRestParamFolder {
-}
-export interface iBXRestParamFolder {
-    id: number;
-}
-export interface iBXRestFolderInfo {
-    ID: number;
-    NAME: string;
-    CODE: null | string;
-    MODULE_ID: string;
-    ENTITY_TYPE: string;
-    ENTITY_ID: string;
-    ROOT_OBJECT_ID: number;
-}
-export interface iBXRestFolder extends iBXRestFolderOrFile, iBXRestFolderBase {
-}
-export interface iBXRestFolderHttp extends iBXRestFolderOrFileHttp, iBXRestFolderBase {
-}
-export interface iBXRestFolderBase extends iBXRestFolderOrFileBase {
-    TYPE: 'folder';
-}
-export interface iBXRestFolderOrFile extends iBXRestFolderOrFileBase {
-    CREATED_BY: number;
-    CREATE_TIME: Date;
-    DELETED_BY: number;
-    DELETED_TYPE: number;
-    DELETE_TIME: null | Date;
-    ID: number;
-    PARENT_ID: number;
-    REAL_OBJECT_ID: number;
-    STORAGE_ID: number;
-    UPDATED_BY: number;
-    UPDATE_TIME: Date;
-}
-export interface iBXRestFolderOrFileHttp extends iBXRestFolderOrFileBase {
-    CREATED_BY: string;
-    CREATE_TIME: string;
-    DELETED_BY: string;
-    DELETED_TYPE: string;
-    DELETE_TIME: null | string;
-    ID: string;
-    PARENT_ID: string;
-    REAL_OBJECT_ID: string;
-    STORAGE_ID: string;
-    UPDATED_BY: string;
-    UPDATE_TIME: string;
-}
-export interface iBXRestFolderOrFileBase {
-    CODE: null;
-    DETAIL_URL: null | string;
-    NAME: string;
-}

package/typification/rest/disk/map.d.ts

@@ -1,6 +0,0 @@
-import { iBXRestFolder } from './folder';
-import { iBXRestDiskFile } from './file';
-export interface iBXRestDiskFileAndFolderMap {
-    file: iBXRestDiskFile[];
-    folder: iBXRestFolder[];
-}

package/typification/rest/disk/storage/getchildren.d.ts

@@ -1,4 +0,0 @@
-export interface iBXRestParamGetchildren {
-    id: number;
-    filter?: any;
-}

package/typification/rest/disk/storage/uploadfile.d.ts

@@ -1,9 +0,0 @@
-export interface iBXRestParamUploadFile {
-    id: number;
-    fileContent: string[];
-    data: {
-        NAME: string;
-    };
-    generateUniqueName?: boolean;
-    rights?: any[];
-}

package/typification/rest/disk.d.ts

@@ -1,15 +0,0 @@
-/**
- * Файл для возможности импорта интерфейсов Disk в локальные проекты
- */
-export * from './disk/AttachedObject';
-export * from './disk/file';
-export * from './disk/folder';
-export * from './disk/folder/addSubFolder';
-export * from './disk/folder/copyTo';
-export * from './disk/folder/getFields';
-export * from './disk/folder/moveTo';
-export * from './disk/folder/rename';
-export * from './disk/folder/uploadFile';
-export * from './disk/map';
-export * from './disk/storage/getchildren';
-export * from './disk/storage/uploadfile';

package/typification/rest/im/chat/add.d.ts

@@ -1,12 +0,0 @@
-export interface iBXRestImChatAddParam {
-    TYPE?: 'OPEN' | 'CHAT';
-    TITLE?: string;
-    DESCRIPTION?: string;
-    COLOR?: string;
-    MESSAGE?: string;
-    USERS: number[];
-    AVATAR?: string;
-    ENTITY_TYPE?: string;
-    ENTITY_ID?: number;
-    OWNER_ID?: number;
-}

package/typification/rest/im/chat/get.d.ts

@@ -1,18 +0,0 @@
-export interface iBXRestImChatGetParam {
-    /**
-     * Идентификатор сущности. Может быть использован для поиска чата и для легкого определения контекста в обработчиках событий:
-     *
-     * ONIMBOTMESSAGEADD
-     * ONIMBOTMESSAGEUPDATE
-     * ONIMBOTMESSAGEDELETE
-     */
-    ENTITY_TYPE: string;
-    /**
-     * Числовой идентификатор сущности. Может быть использован для поиска чата и для легкого определения контекста в обработчиках событий:
-     *
-     * ONIMBOTMESSAGEADD
-     * ONIMBOTMESSAGEUPDATE
-     * ONIMBOTMESSAGEDELETE
-     */
-    ENTITY_ID: number;
-}

package/typification/rest/im/chat/leave.d.ts

@@ -1,4 +0,0 @@
-export interface iBXRestImChatLeaveParam {
-    /** Идентификатор чата */
-    CHAT_ID: number;
-}

package/typification/rest/im/chat/mute.d.ts

@@ -1,10 +0,0 @@
-import { iBXRestYesNo } from '../../base/yes-no';
-export interface iBXRestImChatMuteParam {
-    /** Идентификатор чата */
-    CHAT_ID: number;
-    /**
-     * Варианты ключа MUTE: Y для отключения уведомлений и N для включения
-     */
-    /** Идентификатор чата */
-    MUTE: iBXRestYesNo;
-}

package/typification/rest/im/chat/setOwner.d.ts

@@ -1,6 +0,0 @@
-export interface iBXRestImChatSetOwnerParam {
-    /** Идентификатор чата */
-    CHAT_ID: number;
-    /** Идентификатор нового владельца чата */
-    USER_ID: number;
-}

package/typification/rest/im/chat/updateAvatar.d.ts

@@ -1,6 +0,0 @@
-export interface iBXRestImChatUpdateAvatarParam {
-    /** Идентификатор чата */
-    CHAT_ID: number;
-    /** Изображение в формате base64 */
-    AVATAR: string;
-}

package/typification/rest/im/chat/updateColor.d.ts

@@ -1,9 +0,0 @@
-export interface iBXRestImChatUpdateColor {
-    /** Идентификатор чата */
-    CHAT_ID: number;
-    /**
-     * Цвет чата для мобильного приложения
-     * (RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE)
-     */
-    COLOR: string;
-}

package/typification/rest/im/chat/updateTitle.d.ts

@@ -1,8 +0,0 @@
-export interface iBXRestImChatUpdateTitleParam {
-    /** Идентификатор чата */
-    CHAT_ID: number;
-    /**
-     * Новый заголовок
-     */
-    TITLE: string;
-}

package/typification/rest/im/chat/user/add.d.ts

@@ -1,12 +0,0 @@
-import { iBXRestYesNo } from '../../../base/yes-no';
-export interface iBXRestImChatUserAddParam {
-    /** Идентификатор чата */
-    CHAT_ID: number;
-    /** Идентификаторы новых пользователей*/
-    USERS: number[];
-    /**
-     * Отображение истории переписки для пользователя, которого добавляют в чат этим методом.
-     * Y/N - по умолчанию N. Если передать Y, то новый пользователь не будет видеть историю.
-     */
-    HIDE_HISTORY: iBXRestYesNo;
-}

package/typification/rest/im/chat/user/delete.d.ts

@@ -1,6 +0,0 @@
-export interface iBXRestImChatUserDeleteParam {
-    /** Идентификатор чата */
-    CHAT_ID: number;
-    /** Идентификатор исключаемого пользователя */
-    USER_ID: number;
-}

package/typification/rest/im/chat/user/list.d.ts

@@ -1,4 +0,0 @@
-export interface iBXRestImChatUserListParam {
-    /** Идентификатор чата */
-    CHAT_ID: number;
-}

package/typification/rest/im/counters/get.d.ts

@@ -1,13 +0,0 @@
-export interface iBXRestImCountersType {
-    ALL: number;
-    CHAT: number;
-    DIALOG: number;
-    LINES: number;
-    NOTIFY: number;
-}
-export interface iBXRestImCounters {
-    CHAT: Record<string, number>;
-    DIALOG: Record<string, number>;
-    LINES: Record<string, number>;
-    TYPE: iBXRestImCountersType;
-}

package/typification/rest/im/dialog/get.d.ts

@@ -1,83 +0,0 @@
-export interface iBXRestImDialogGetParam {
-    /**
-     * Идентификатор диалога. Формат:
-     *
-     * chatXXX – чат получателя, если сообщение для чата
-     * XXX – идентификатор получателя, если сообщение для приватного диалога
-     */
-    DIALOG_ID: string | number;
-}
-export interface iBXRestImDialogGet extends iBXRestImDialogGetBase {
-    /**
-     * идентификатор чата
-     */
-    id: number;
-    /**
-     * идентификатор пользователя владельца чата
-     */
-    owner: number;
-    /**
-     * дата создания чата
-     */
-    date_create: Date;
-}
-export interface iBXRestImDialogGetHttp extends iBXRestImDialogGetBase {
-    /**
-     * идентификатор чата
-     */
-    id: string;
-    /**
-     * идентификатор пользователя владельца чата
-     */
-    owner: string;
-    /**
-     * дата создания чата в формате АТОМ
-     */
-    date_create: string;
-}
-export interface iBXRestImDialogGetBase {
-    /**
-     * название чата
-     */
-    title: string;
-    /**
-     * признак участия в чате внешнего экстранет-пользователя (true/false)
-     */
-    extranet: boolean;
-    /**
-     * ссылка на аватар (если пусто, значит аватар не задан)
-     */
-    avatar: string;
-    /**
-     * цвет чата в формате hex TODO: типизировать
-     */
-    color: string;
-    /**
-     * тип чата (групповой чат, чат для звонка, чат открытой линии и тд)
-     */
-    type: string;
-    /**
-     * внешний код для чата – тип
-     */
-    entity_type: string;
-    /**
-     * внешний код для чата – идентификатор
-     */
-    entity_id: string;
-    /**
-     * нешние данные для чата
-     */
-    entity_data_1: string;
-    /**
-     * нешние данные для чата
-     */
-    entity_data_2: string;
-    /**
-     * нешние данные для чата
-     */
-    entity_data_3: string;
-    /**
-     * тип сообщений чата
-     */
-    message_type: string;
-}

package/typification/rest/im/dialog/messages/get.d.ts

@@ -1,180 +0,0 @@
-import { iBXRestYesNo } from '../../../base/yes-no';
-import { iBXRestImDialogGetParam } from '../get';
-export interface iBXRestImDialogMessagesGetParam extends iBXRestImDialogGetParam {
-    /**  Идентификатор последнего загруженного сообщения */
-    LAST_ID?: number;
-    /** Идентификатор первого загруженного сообщения */
-    FIRST_ID?: number;
-    /** Ограничение на выборку сообщений в диалоге */
-    LIMIT?: number;
-}
-export type iBXRestImDialogMessagesGet = iBXRestImDialogMessagesGetBase<iBXRestImDialogMessagesGetMessage>;
-export type iBXRestImDialogMessagesGetHttp = iBXRestImDialogMessagesGetBase<iBXRestImDialogMessagesGetMessageHttp>;
-export interface iBXRestImDialogMessagesGetBase<message = iBXRestImDialogMessagesGetMessageBase> {
-    /** массив сообщений */
-    messages: message[];
-    /** обьекты описания данных пользователя */
-    users: iBXRestImDialogMessagesGetUser[];
-    /** обьект, описывающий файлы в выбранных сообщениях */
-    files: iBXRestImDialogMessagesGetChatFile[];
-    /** идентификатор чата */
-    chat_id: number;
-}
-export interface iBXRestImDialogMessagesGetMessage extends iBXRestImDialogMessagesGetBase {
-    /** Дата сообщения */
-    date: Date;
-    /** Параметры сообщения (может быть null) */
-    params: iBXRestImDialogMessagesGetMessageParams | null;
-}
-export interface iBXRestImDialogMessagesGetMessageHttp extends iBXRestImDialogMessagesGetBase {
-    /** Дата сообщения в формате ATOM */
-    date: string;
-    /** Параметры сообщения (может быть null) */
-    params: iBXRestImDialogMessagesGetMessageParamsHttp | null;
-}
-export interface iBXRestImDialogMessagesGetMessageBase {
-    /** Идентификатор сообщения */
-    id: number;
-    /** Идентификатор чата */
-    chat_id: number;
-    /** Автор сообщения (0 — системное сообщение) */
-    author_id: number;
-    /** Текст сообщения */
-    text: string;
-    /** Параметры сообщения (может быть null) */
-    params: iBXRestImDialogMessagesGetBase | null;
-}
-export interface iBXRestImDialogMessagesGetMessageParams extends iBXRestImDialogMessagesGetMessageParamsBase {
-    /** Признак того, что сообщение содержит только ссылку */
-    URL_ONLY?: boolean;
-    /** Признак отредактированного сообщения */
-    IS_EDITED?: boolean;
-    /** Признак удаленного сообщения */
-    IS_DELETED?: boolean;
-}
-export interface iBXRestImDialogMessagesGetMessageParamsHttp extends iBXRestImDialogMessagesGetMessageParamsBase {
-    /** Признак того, что сообщение содержит только ссылку */
-    URL_ONLY?: iBXRestYesNo;
-    /** Признак отредактированного сообщения */
-    IS_EDITED?: iBXRestYesNo;
-    /** Признак удаленного сообщения */
-    IS_DELETED?: iBXRestYesNo;
-}
-export interface iBXRestImDialogMessagesGetMessageParamsBase {
-    /** Массив идентификаторов URL */
-    URL_ID?: number[];
-    /** Массив идентификаторов прикрепленных файлов */
-    FILE_ID?: number[];
-    /** Массив пользователей, поставивших "лайк" */
-    LIKE?: number[];
-    /** Массив блоков расширенного оформления */
-    ATTACH?: iBXRestImDialogMessagesGetMessageParamsAttachment[];
-    /** Объект клавиатуры (опционально) */
-    KEYBOARD?: any;
-}
-interface iBXRestImDialogMessagesGetMessageParamsAttachment {
-    ID: string;
-    COLOR: string;
-    BLOCKS: iBXRestImDialogMessagesGetMessageParamsAttachmentBlock[];
-}
-interface iBXRestImDialogMessagesGetMessageParamsAttachmentBlock {
-    RICH_LINK?: iBXRestImDialogMessagesGetMessageParamsAttachmentRichLink[];
-}
-interface iBXRestImDialogMessagesGetMessageParamsAttachmentRichLink {
-    /** Название ссылки */
-    NAME: string;
-    /** URL ссылки */
-    LINK: string;
-    /** Описание ссылки */
-    DESC: string;
-    /** URL изображения-превью */
-    PREVIEW: string;
-}
-interface iBXRestImDialogMessagesGetUser {
-    /** Идентификатор пользователя */
-    id: number;
-    /** Имя и фамилия */
-    name: string;
-    /** Имя */
-    first_name: string;
-    /** Фамилия */
-    last_name: string;
-    /** Должность */
-    work_position: string;
-    /** Цвет (в HEX) */
-    color: string;
-    /** Ссылка на аватар (может быть пустой строкой) */
-    avatar: string;
-    /** Пол: "M" или "F" */
-    gender: string;
-    /** День рождения в формате DD-MM или пустая строка */
-    birthday: string;
-    /** Признак экстранет-пользователя */
-    extranet: boolean;
-    /** Признак Bitrix24.Network-пользователя */
-    network: boolean;
-    /** Признак бота */
-    bot: boolean;
-    /** Признак открытых линий */
-    connector: boolean;
-    /** Код внешней авторизации */
-    external_auth_id: string;
-    /** Статус пользователя (например, "online") */
-    status: string;
-    /** Время ухода от компьютера или false */
-    idle: string | false;
-    /** Дата последней активности или false */
-    last_activity_date: string | false;
-    /** Дата активности в мобильном приложении или false */
-    mobile_last_date: string | false;
-    /** Дата окончания отпуска или false */
-    absent: string | false;
-    /** Подразделения */
-    departments: number[];
-    /** Телефоны или false */
-    phones: iBXRestImDialogMessagesGetUserPhones | false;
-}
-interface iBXRestImDialogMessagesGetUserPhones {
-    /** Рабочий телефон */
-    work_phone?: string;
-    /** Мобильный телефон */
-    personal_mobile?: string;
-    /** Домашний телефон */
-    personal_phone?: string;
-}
-interface iBXRestImDialogMessagesGetChatFile {
-    /** Идентификатор файла */
-    id: number;
-    /** Идентификатор чата */
-    chatId: number;
-    /** Дата добавления */
-    date: string;
-    /** Тип: "image" или "file" */
-    type: 'image' | 'file';
-    /** Имя файла */
-    name: string;
-    /** Размер файла в байтах */
-    size: number;
-    /** Превью (может быть пустым) */
-    preview: string;
-    /** Размер изображения, если применимо */
-    image?: {
-        width: number;
-        height: number;
-    };
-    /** Статус загрузки */
-    status: 'done' | 'upload';
-    /** Прогресс загрузки: 0–100, -1 если неизвестен */
-    progress: number;
-    /** Идентификатор автора */
-    authorId: number;
-    /** Имя автора */
-    authorName: string;
-    /** Ссылка на предпросмотр (только для изображений) */
-    urlPreview?: string;
-    /** Ссылка на просмотр */
-    urlShow: string;
-    /** Ссылка на скачивание */
-    urlDownload: string;
-}
-export {};

package/typification/rest/im/dialog/read.d.ts

@@ -1,25 +0,0 @@
-import { iBXRestImDialogGetParam } from './get';
-export interface iBXRestImDialogReadParam extends iBXRestImDialogGetParam {
-    /**
-     * Идентификатор последнего прочитанного сообщения в диалоге
-     */
-    MESSAGE_ID: number;
-}
-export interface iBXRestImDialogRead {
-    /**
-     * идентификатор прочитанного диалога
-     */
-    dialogId: string;
-    /**
-     * идентификатор чата
-     */
-    chatId: number;
-    /**
-     * кол-во непрочитанных сообщений после выполнения метода
-     */
-    counter: number;
-    /**
-     * последнее прочитанное сообщение
-     */
-    lastId: number;
-}