bx-rest 0.10.5 → 0.10.6

package/typification/rest/crm/status.d.ts

@@ -0,0 +1,167 @@
+import { iBXRestPagination } from '../base/api-pagination-bx';
+import { iBXRestParamSort } from '../base/sort';
+import { iBXRestYesNo } from '../base/yes-no';
+import { iBXRestCrmFieldDescription } from './enum';
+/** Группа стадии: успех, провал или стадия в работе. */
+export type iBXRestCrmStatusSemantics = 'S' | 'F' | '';
+/** Поля нового элемента справочника CRM. */
+export interface iBXRestCrmStatusAddFields {
+    /** Символьный идентификатор справочника, например `DEAL_STAGE` или `SOURCE`. */
+    ENTITY_ID: string;
+    /** Уникальный в рамках справочника код значения. */
+    STATUS_ID: string;
+    /** Отображаемое название значения. */
+    NAME: string;
+    /** Позиция значения в справочнике. По умолчанию 10. */
+    SORT?: number;
+    /** Цвет стадии в формате hex, например `#39A8EF`. */
+    COLOR?: string;
+    /** Группа стадии: `S` — успех, `F` — провал, пустая строка — в работе. */
+    SEMANTICS?: iBXRestCrmStatusSemantics;
+}
+/** Изменяемые поля элемента справочника CRM. */
+export interface iBXRestCrmStatusUpdateFields {
+    /** Новое отображаемое название. */
+    NAME?: string;
+    /** Новая позиция в справочнике. */
+    SORT?: number;
+    /** Новый цвет стадии в формате hex. */
+    COLOR?: string;
+}
+/** Параметры метода `crm.status.add`. */
+export interface iBXRestParamCrmStatusAdd {
+    /** Поля нового элемента справочника. */
+    fields: iBXRestCrmStatusAddFields;
+}
+/** Параметры метода `crm.status.update`. */
+export interface iBXRestParamCrmStatusUpdate {
+    /** Числовой идентификатор изменяемого элемента. */
+    id: number;
+    /** Изменяемые поля элемента справочника. */
+    fields: iBXRestCrmStatusUpdateFields;
+}
+/** Параметры методов, принимающих идентификатор элемента справочника. */
+export interface iBXRestParamCrmStatusId {
+    /** Числовой идентификатор элемента справочника. */
+    id: number;
+}
+/** Параметры метода `crm.status.get`. */
+export type iBXRestParamCrmStatusGet = iBXRestParamCrmStatusId;
+/** Параметры метода `crm.status.delete`. */
+export interface iBXRestParamCrmStatusDelete extends iBXRestParamCrmStatusId {
+    params?: {
+        /** Разрешает удалить системный элемент справочника. По умолчанию `N`. */
+        FORCED?: iBXRestYesNo;
+    };
+}
+/** Поля элемента справочника, доступные для сортировки и фильтрации. */
+export type iBXRestCrmStatusField = 'ID' | 'ENTITY_ID' | 'STATUS_ID' | 'SORT' | 'NAME' | 'NAME_INIT' | 'SYSTEM' | 'CATEGORY_ID' | 'COLOR' | 'SEMANTICS' | 'EXTRA';
+/** Параметры метода `crm.status.list`. */
+export interface iBXRestParamCrmStatusList extends iBXRestPagination {
+    /** Порядок сортировки элементов по полям справочника. */
+    order?: Partial<Record<iBXRestCrmStatusField, iBXRestParamSort>>;
+    /** Фильтр по полям справочника, включая REST-префиксы операторов. */
+    filter?: Record<string, any>;
+}
+/** Параметры метода `crm.status.entity.items`. */
+export interface iBXRestParamCrmStatusEntityItems {
+    /** Символьный идентификатор справочника, например `DEAL_STAGE` или `SOURCE`. */
+    entityId: string;
+}
+/** Дополнительные данные элемента справочника. */
+export interface iBXRestCrmStatusExtra extends Record<string, any> {
+    /** Семантика стадии в человекочитаемом формате. */
+    SEMANTICS?: string;
+    /** Цвет стадии в формате hex. */
+    COLOR?: string;
+}
+interface iBXRestCrmStatusBase {
+    /** Символьный идентификатор справочника. */
+    ENTITY_ID: string;
+    /** Код значения, используемый в полях элементов CRM. */
+    STATUS_ID: string;
+    /** Отображаемое название. */
+    NAME: string;
+    /** Исходное системное название. */
+    NAME_INIT: string;
+    /** Цвет стадии в формате hex. */
+    COLOR: string;
+    /** Группа стадии. */
+    SEMANTICS: iBXRestCrmStatusSemantics | null;
+    /** Дополнительные данные элемента. */
+    EXTRA?: iBXRestCrmStatusExtra;
+}
+/** Элемент справочника CRM в локальном формате библиотеки. */
+export interface iBXRestCrmStatus extends iBXRestCrmStatusBase {
+    /** Числовой идентификатор элемента. */
+    ID: number;
+    /** Позиция элемента в справочнике. */
+    SORT: number;
+    /** Является ли элемент системным. */
+    SYSTEM: boolean;
+    /** Идентификатор воронки для статуса-стадии. */
+    CATEGORY_ID: number | null;
+}
+/** Элемент справочника CRM в формате ответа Bitrix24. */
+export interface iBXRestCrmStatusHttp extends iBXRestCrmStatusBase {
+    ID: string;
+    SORT: string;
+    SYSTEM: iBXRestYesNo;
+    CATEGORY_ID: string | null;
+}
+/** Краткое представление элемента, возвращаемое `crm.status.entity.items`. */
+export interface iBXRestCrmStatusEntityItem {
+    /** Отображаемое название. */
+    NAME: string;
+    /** Позиция элемента в справочнике. */
+    SORT: number;
+    /** Код значения, используемый в полях элементов CRM. */
+    STATUS_ID: string;
+}
+/** Семантические границы справочника стадий. */
+export interface iBXRestCrmStatusSemanticInfo {
+    /** Код начальной стадии. */
+    START_FIELD: string;
+    /** Код успешной финальной стадии. */
+    FINAL_SUCCESS_FIELD: string;
+    /** Код неуспешной финальной стадии. */
+    FINAL_UNSUCCESS_FIELD: string;
+    /** Позиция финальной стадии. */
+    FINAL_SORT: number;
+}
+interface iBXRestCrmStatusEntityTypeBase {
+    /** Символьный идентификатор справочника для параметра `ENTITY_ID`. */
+    ID: string;
+    /** Отображаемое название справочника. */
+    NAME: string;
+    /** Тип объекта CRM, к которому относится справочник стадий. */
+    ENTITY_TYPE_ID?: number;
+    /** Семантические границы стадий; некоторые типы API возвращают пустой массив. */
+    SEMANTIC_INFO?: iBXRestCrmStatusSemanticInfo | [];
+    /** Префикс кода стадии воронки. */
+    PREFIX?: string;
+    /** Область применения поля, соответствующая воронке. */
+    FIELD_ATTRIBUTE_SCOPE?: string;
+    /** Активен ли тип справочника. */
+    IS_ENABLED?: boolean;
+    /** Идентификатор родительского справочника. */
+    PARENT_ID?: string;
+    /** Название воронки. */
+    CATEGORY_NAME?: string;
+    /** Позиция воронки. */
+    CATEGORY_SORT?: number;
+    /** Является ли воронка воронкой по умолчанию. */
+    IS_DEFAULT_CATEGORY?: boolean;
+}
+/** Описание типа справочника в локальном формате библиотеки. */
+export interface iBXRestCrmStatusEntityType extends iBXRestCrmStatusEntityTypeBase {
+    /** Идентификатор воронки. */
+    CATEGORY_ID?: number;
+}
+/** Описание типа справочника в формате ответа Bitrix24. */
+export interface iBXRestCrmStatusEntityTypeHttp extends iBXRestCrmStatusEntityTypeBase {
+    CATEGORY_ID?: number | string;
+}
+/** Описание полей, возвращаемое методом `crm.status.fields`. */
+export type iBXRestCrmStatusFields = Record<iBXRestCrmStatusField, iBXRestCrmFieldDescription>;
+export {};

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

@@ -0,0 +1,6 @@
+export interface iBXRestParamDepartmentAdd {
+    NAME: string;
+    SORT?: number;
+    PARENT: number;
+    UF_HEAD: number;
+}

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

@@ -0,0 +1,3 @@
+export interface iBXRestParamDepartmentDel {
+    ID: number;
+}

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

@@ -0,0 +1,14 @@
+export interface iBXRestDepartment extends iBXRestDepartmentBase {
+    ID: number;
+    PARENT?: number;
+    UF_HEAD: number;
+}
+export interface iBXRestDepartmentHttp extends iBXRestDepartmentBase {
+    ID: string;
+    PARENT?: string;
+    UF_HEAD: string;
+}
+export interface iBXRestDepartmentBase {
+    NAME: string;
+    SORT: number;
+}

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

@@ -0,0 +1,10 @@
+import { iBXRestPagination } from '../base/api-pagination-bx';
+import { iBXRestParamSort } from '../base/sort';
+export interface iBXRestParamDepartmentGet extends iBXRestPagination {
+    ID?: number | number[];
+    NAME?: string;
+    SORT?: number;
+    PARENT?: number;
+    UF_HEAD?: number;
+    ORDER?: iBXRestParamSort;
+}

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

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

package/typification/rest/department.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Файл для возможности импорта интерфейсов подразделений в локальные проекты
+ */
+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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/typification/rest/disk.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Файл для возможности импорта интерфейсов 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

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

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

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

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

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

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

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

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

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

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

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

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

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;
+}