bx-rest 0.6.4 → 0.6.6

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

@@ -0,0 +1,12 @@
+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

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

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

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

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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,83 @@
+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

@@ -0,0 +1,180 @@
+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

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

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

@@ -0,0 +1,172 @@
+import { iBXRestYesNo } from '../../../base/yes-no';
+export interface iBXRestImDialogRecentGetParam {
+    /**
+     * Пропускать чаты открытых линий
+     */
+    SKIP_OPENLINES?: iBXRestYesNo;
+    /** Пропускать чаты */
+    SKIP_CHAT?: iBXRestYesNo;
+    /** Пропускать диалоги один-на-один */
+    SKIP_DIALOG?: iBXRestYesNo;
+    /**
+     * Ограничение выборки для минимизации переданных данных.
+     */
+    LAST_UPDATE?: Date;
+    /**
+     * Выборка только чатов открытых линий
+     */
+    ONLY_OPENLINES?: iBXRestYesNo;
+    /**
+     * Дата предыдущей выборки для загрузки изменений, произошедших в списке с этого времени.
+     * Выборка возвращает данные не старше 7 дней.
+     */
+    LAST_SYNC_DATE?: Date;
+}
+export interface iBXRestImDialogRecentGetAvatar {
+    /** Ссылка на аватар (если пусто — аватар не задан) */
+    url: string;
+    /** Цвет диалога в формате hex */
+    color: string;
+}
+export interface iBXRestImDialogRecentGetMessage {
+    /** Идентификатор сообщения */
+    id: string;
+    /** Текст сообщения (без BB-кодов и переносов строк) */
+    text: string;
+    /** Признак наличия файлов */
+    file: boolean;
+    /** Признак наличия вложений */
+    attach: boolean;
+    /** Идентификатор автора сообщения */
+    author_id: string;
+}
+export interface iBXRestImDialogRecentGetUserData extends iBXRestImDialogRecentGetUserDataBase {
+    /** Идентификатор пользователя */
+    id: number;
+    /** Дата последнего действия пользователя */
+    last_activity_date: Date | false;
+    /** Дата последней активности в мобильном приложении или false */
+    mobile_last_date: Date | false;
+    /** Дата окончания отпуска или false */
+    absent: Date | false;
+}
+export interface iBXRestImDialogRecentGetUserDataHttp extends iBXRestImDialogRecentGetUserDataBase {
+    /** Идентификатор пользователя */
+    id: string;
+    /** Дата последнего действия пользователя */
+    last_activity_date: string;
+    /** Дата последней активности в мобильном приложении или false */
+    mobile_last_date: string | false;
+    /** Дата окончания отпуска или false */
+    absent: string | false;
+}
+export interface iBXRestImDialogRecentGetUserDataBase {
+    /** Полное имя (имя и фамилия) */
+    name: string;
+    /** Имя пользователя */
+    first_name: string;
+    /** Фамилия пользователя */
+    last_name: string;
+    /** Должность пользователя */
+    work_position: string;
+    /** Цвет в формате hex */
+    color: string;
+    /** Ссылка на аватар */
+    avatar: string;
+    /** Пол пользователя (M/F) */
+    gender: string;
+    /** День рождения в формате DD-MM или false */
+    birthday: string | false;
+    /** Внешний экстранет-пользователь */
+    extranet: boolean;
+    /** Пользователь Битрикс24.Network */
+    network: boolean;
+    /** Бот */
+    bot: boolean;
+    /** Пользователь открытых линий */
+    connector: boolean;
+    /** Код внешней авторизации */
+    external_auth_id: string;
+    /** Статус пользователя (например, online) */
+    status: string;
+    /** Дата, когда пользователь отошел от компьютера, или false */
+    idle: string | false;
+}
+export interface iBXRestImDialogRecentGetChatData extends iBXRestImDialogRecentGetChatDataBase {
+    /** Идентификатор чата */
+    id: number;
+    /** Дата создания чата */
+    date_create: Date;
+}
+export interface iBXRestImDialogRecentGetChatDataHttp extends iBXRestImDialogRecentGetChatDataBase {
+    /** Идентификатор чата */
+    id: string;
+    /** Дата создания чата */
+    date_create: string;
+}
+export interface iBXRestImDialogRecentGetChatDataBase {
+    /** Название чата */
+    title: string;
+    /** Идентификатор владельца чата */
+    owner: string;
+    /** Признак участия внешнего пользователя */
+    extranet: boolean;
+    /** Ссылка на аватар чата */
+    avatar: string;
+    /** Цвет чата */
+    color: string;
+    /** Тип чата (chat, openline и т.д.) */
+    type: string;
+    /** Внешний код чата — тип */
+    entity_type: string;
+    /** Внешний код чата — идентификатор (может отсутствовать) */
+    entity_id?: string;
+    /** Внешние данные для чата (1) */
+    entity_data_1: string;
+    /** Внешние данные для чата (2) */
+    entity_data_2: string;
+    /** Внешние данные для чата (3) */
+    entity_data_3: string;
+    /** Тип сообщений в чате (обычно "C") */
+    message_type: string;
+}
+export interface iBXRestImDialogRecentGet extends iBXRestImDialogRecentGetBase {
+    /** Дата последнего сообщения */
+    date_update: Date;
+    /** Объект пользователя, если type === 'user' */
+    user?: iBXRestImDialogRecentGetUserData;
+    /** Объект чата, если type === 'chat' */
+    chat?: iBXRestImDialogRecentGetChatData;
+}
+export interface iBXRestImDialogRecentGetHttp extends iBXRestImDialogRecentGetBase {
+    /** Дата последнего сообщения */
+    date_update: string;
+    /**
+     * Объект пользователя, если type === 'user'
+     * Посмотреть бы в глаза тому человеку что эту хуету сделала, ну тип {id: 0} это ахуй
+     *
+     */
+    user?: iBXRestImDialogRecentGetUserDataHttp | {
+        id: 0;
+    };
+    /** Объект чата, если type === 'chat' */
+    chat?: iBXRestImDialogRecentGetChatDataHttp;
+}
+export interface iBXRestImDialogRecentGetBase {
+    /** Идентификатор записи: число для пользователя, строка "chatXXX" для чата */
+    id: string | number;
+    /** Количество непрочитанных сообщений */
+    counter: number;
+    /** Тип записи: 'user' или 'chat' */
+    type: 'user' | 'chat';
+    /** Объект аватара */
+    avatar: iBXRestImDialogRecentGetAvatar;
+    /** Заголовок: имя пользователя или название чата */
+    title: string;
+    /** Последнее сообщение */
+    message: iBXRestImDialogRecentGetMessage;
+    /** Объект пользователя, если type === 'user' */
+    user?: iBXRestImDialogRecentGetUserDataBase | {
+        id: 0;
+    };
+}