bx-rest 0.10.6 → 0.11.0

package/request-navvy/crm/timeline/note.d.ts

@@ -0,0 +1,33 @@
+import { iBXRestCrmTimelineNote, iBXRestParamCrmTimelineNote, iBXRestParamCrmTimelineNoteSave } from '../../../typification/rest/crm';
+/** Заметки к записям таймлайна и делам (`crm.timeline.note.*`). */
+export declare class BXRestNavvyCrmTimelineNote {
+    private readonly Navvy;
+    readonly url: {
+        /** Возвращает заметку к записи таймлайна или делу. */
+        get: string[];
+        /** Создает или обновляет заметку. */
+        save: string[];
+        /** Удаляет заметку. */
+        delete: string[];
+    };
+    /**
+     * Возвращает заметку к записи истории таймлайна или делу CRM.
+     *
+     * В `itemType` передайте `1` для записи истории или `2` для дела.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-get.html
+     */
+    get(param: iBXRestParamCrmTimelineNote): import("../../../services/navvy").NavvySimple<iBXRestCrmTimelineNote, iBXRestCrmTimelineNote, iBXRestParamCrmTimelineNote | undefined>;
+    /**
+     * Создает заметку или заменяет текст существующей.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-save.html
+     */
+    save(param: iBXRestParamCrmTimelineNoteSave): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmTimelineNoteSave | undefined>;
+    /**
+     * Удаляет заметку у записи истории таймлайна или дела CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-delete.html
+     */
+    delete(param: iBXRestParamCrmTimelineNote): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmTimelineNote | undefined>;
+}

package/request-navvy/crm.d.ts

@@ -15,7 +15,10 @@ import { BXRestNavvyCrmEntity } from './crm/entity';
 import { BXRestNavvyCrmCallList } from './crm/calllist/index';
 import { BXRestNavvyCrmAddress } from './crm/address';
 import { BXRestNavvyCrmRequisite } from './crm/requisite/index';
+import { BXRestNavvyCrmTimeline } from './crm/timeline/index';
 export declare class BXRestNavvyCrm {
+    /** Таймлайн CRM: комментарии, заметки, связи и лог-записи (`crm.timeline.*`). */
+    readonly timeline: BXRestNavvyCrmTimeline;
     /** Адреса CRM, в том числе адреса реквизитов (`crm.address.*`). */
     readonly address: BXRestNavvyCrmAddress;
     /** Реквизиты, банковские данные, связи и шаблоны (`crm.requisite.*`). */

package/typification/rest/bizproc/activity.d.ts

@@ -0,0 +1,25 @@
+import { iBXRestBizprocRegistrationFields } from './base/registration';
+/** Параметры `bizproc.activity.add`. */
+export interface iBXRestParamBizprocActivityAdd extends iBXRestBizprocRegistrationFields {
+    /** Уникальный в рамках приложения символьный код действия. */
+    CODE: string;
+}
+/** Параметры `bizproc.activity.update`. */
+export interface iBXRestParamBizprocActivityUpdate {
+    /** Символьный код зарегистрированного действия. */
+    CODE: string;
+    /** Новые поля действия. */
+    FIELDS: iBXRestBizprocRegistrationFields;
+}
+/** Параметры `bizproc.activity.delete`. */
+export interface iBXRestParamBizprocActivityDelete {
+    /** Символьный код зарегистрированного действия. */
+    CODE: string;
+}
+/** Параметры `bizproc.activity.log`. */
+export interface iBXRestParamBizprocActivityLog {
+    /** Актуальный токен события, полученный обработчиком действия. */
+    EVENT_TOKEN: string;
+    /** Сообщение для журнала бизнес-процесса. */
+    LOG_MESSAGE: string;
+}

package/typification/rest/bizproc/base/registration.d.ts

@@ -0,0 +1,66 @@
+import { iBXRestYesNo } from '../../base/yes-no';
+/** Строка или набор ее локализованных вариантов. */
+export type iBXRestBizprocLocalizedString = string | Record<string, string>;
+/**
+ * Тип документа в формате `[модуль, объект, тип документа]`.
+ *
+ * @example ['crm', 'CCrmDocumentDeal', 'DEAL']
+ */
+export type iBXRestBizprocDocumentType = [
+    moduleId: string,
+    entity: string,
+    documentType: string
+];
+/** Правило доступности действия или робота для документа либо редакции Битрикс24. */
+export type iBXRestBizprocRegistrationFilterRule = string | string[];
+/** Ограничения видимости действия или робота. */
+export interface iBXRestBizprocRegistrationFilter {
+    /** Правила, для которых действие или робот отображается. */
+    INCLUDE?: iBXRestBizprocRegistrationFilterRule[];
+    /** Правила, для которых действие или робот скрывается. */
+    EXCLUDE?: iBXRestBizprocRegistrationFilterRule[];
+}
+/** Базовые типы параметров действия или робота. */
+export type iBXRestBizprocRegistrationPropertyType = 'bool' | 'date' | 'datetime' | 'double' | 'file' | 'int' | 'select' | 'string' | 'text' | 'user';
+/** Описание входного или выходного параметра действия либо робота. */
+export interface iBXRestBizprocRegistrationProperty {
+    /** Отображаемое имя параметра. */
+    Name: iBXRestBizprocLocalizedString;
+    /** Описание параметра. */
+    Description?: iBXRestBizprocLocalizedString;
+    /** Тип данных параметра. */
+    Type: iBXRestBizprocRegistrationPropertyType | string;
+    /** Варианты значения для параметра типа `select`. */
+    Options?: Record<string, string> | string[];
+    /** Является ли параметр обязательным. */
+    Required?: iBXRestYesNo;
+    /** Допускает ли параметр несколько значений. */
+    Multiple?: iBXRestYesNo;
+    /** Значение по умолчанию. */
+    Default?: unknown;
+}
+/** Поля регистрации действия или робота приложения. */
+export interface iBXRestBizprocRegistrationFields {
+    /** URL обработчика на домене установленного приложения. */
+    HANDLER: string;
+    /** Пользователь, чей токен будет передан обработчику. */
+    AUTH_USER_ID?: number;
+    /** Должен ли бизнес-процесс ожидать ответ приложения. */
+    USE_SUBSCRIPTION?: iBXRestYesNo;
+    /** Название действия или робота. */
+    NAME: iBXRestBizprocLocalizedString;
+    /** Описание действия или робота. */
+    DESCRIPTION?: iBXRestBizprocLocalizedString;
+    /** Входные параметры. */
+    PROPERTIES?: Record<string, iBXRestBizprocRegistrationProperty>;
+    /** Выходные параметры. */
+    RETURN_PROPERTIES?: Record<string, iBXRestBizprocRegistrationProperty>;
+    /** Тип документа, определяющий типы входных и выходных параметров. */
+    DOCUMENT_TYPE?: iBXRestBizprocDocumentType;
+    /** Ограничения по типу документа и редакции Битрикс24. */
+    FILTER?: iBXRestBizprocRegistrationFilter;
+    /** Включает дополнительные настройки во встройке приложения. */
+    USE_PLACEMENT?: iBXRestYesNo;
+    /** URL обработчика встройки; обязателен при `USE_PLACEMENT: 'Y'`. */
+    PLACEMENT_HANDLER?: string;
+}

package/typification/rest/bizproc/event.d.ts

@@ -0,0 +1,9 @@
+/** Параметры `bizproc.event.send`. */
+export interface iBXRestParamBizprocEventSend {
+    /** Актуальный токен события, полученный обработчиком действия или робота. */
+    EVENT_TOKEN: string;
+    /** Значения зарегистрированных выходных параметров. */
+    RETURN_VALUES?: Record<string, unknown>;
+    /** Сообщение для журнала бизнес-процесса. */
+    LOG_MESSAGE?: string;
+}

package/typification/rest/bizproc/robot.d.ts

@@ -0,0 +1,18 @@
+import { iBXRestBizprocRegistrationFields } from './base/registration';
+/** Параметры `bizproc.robot.add`. */
+export interface iBXRestParamBizprocRobotAdd extends iBXRestBizprocRegistrationFields {
+    /** Уникальный в рамках приложения символьный код робота. */
+    CODE: string;
+}
+/** Параметры `bizproc.robot.update`. */
+export interface iBXRestParamBizprocRobotUpdate {
+    /** Символьный код зарегистрированного робота. */
+    CODE: string;
+    /** Новые поля робота. */
+    FIELDS: iBXRestBizprocRegistrationFields;
+}
+/** Параметры `bizproc.robot.delete`. */
+export interface iBXRestParamBizprocRobotDelete {
+    /** Символьный код зарегистрированного робота. */
+    CODE: string;
+}

package/typification/rest/bizproc/task/complete.d.ts

@@ -1,7 +1,13 @@
+/** Допустимый результат выполнения задания бизнес-процесса. */
 export type iBXRestBizprocTaskCompleteStatus = 1 | 2 | 3 | 4 | 'yes' | 'no' | 'ok' | 'cancel';
+/** Параметры `bizproc.task.complete`. */
 export interface iBXRestParamBizprocTaskComplete {
+    /** Идентификатор задания. */
     TASK_ID: number;
+    /** Целевой статус задания. */
     STATUS: iBXRestBizprocTaskCompleteStatus;
+    /** Комментарий пользователя. */
     COMMENT?: string;
+    /** Значения полей задания с запросом дополнительной информации. */
     FIELDS?: Record<string, unknown>;
 }

package/typification/rest/bizproc/task/delegate.d.ts

@@ -1,5 +1,9 @@
+/** Параметры `bizproc.task.delegate`. */
 export interface iBXRestParamBizprocTaskDelegate {
+    /** Идентификаторы делегируемых заданий. */
     TASK_IDS: number[];
+    /** Пользователь, от которого делегируются задания. */
     FROM_USER_ID: number;
+    /** Пользователь, которому делегируются задания. */
     TO_USER_ID: number;
 }

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

@@ -1,3 +1,5 @@
+/** Параметры `bizproc.workflow.kill`. */
 export interface iBXRestParamBizprocWorkflowKill {
-    ID: string;
+    /** Идентификатор запущенного бизнес-процесса. */
+    ID: number | string;
 }

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

@@ -1,5 +1,13 @@
+/** Параметры `bizproc.workflow.start`. */
 export interface iBXRestParamBizprocWorkflowStart {
+    /** Идентификатор шаблона бизнес-процесса. */
     TEMPLATE_ID: number;
+    /**
+     * Документ в формате `[модуль, объект, идентификатор элемента]`.
+     *
+     * @example ['crm', 'CCrmDocumentDeal', 'DEAL_777']
+     */
     DOCUMENT_ID: string[];
-    PARAMETERS: any;
+    /** Значения входных параметров шаблона. */
+    PARAMETERS?: Record<string, unknown>;
 }

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

@@ -0,0 +1,21 @@
+import { iBXRestBizprocDocumentType } from '../../base/registration';
+/** Настройка автоматического запуска шаблона бизнес-процесса. */
+export type iBXRestBizprocWorkflowTemplateAutoExecute = 0 | 1 | 2 | 3;
+/** Файл шаблона в формате `[имя файла, содержимое Base64]`. */
+export type iBXRestBizprocWorkflowTemplateFile = [
+    fileName: string,
+    base64Content: string
+];
+/** Параметры `bizproc.workflow.template.add`. */
+export interface iBXRestParamBizprocWorkflowTemplateAdd {
+    /** Тип объектов, к которым будет привязан шаблон. */
+    DOCUMENT_TYPE: iBXRestBizprocDocumentType;
+    /** Название шаблона. */
+    NAME: string;
+    /** Описание шаблона. */
+    DESCRIPTION?: string;
+    /** Содержимое файла `.bpt`. */
+    TEMPLATE_DATA: iBXRestBizprocWorkflowTemplateFile;
+    /** Режим автозапуска; по умолчанию `0`. */
+    AUTO_EXECUTE?: iBXRestBizprocWorkflowTemplateAutoExecute;
+}

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

@@ -0,0 +1,5 @@
+/** Параметры `bizproc.workflow.template.delete`. */
+export interface iBXRestParamBizprocWorkflowTemplateDelete {
+    /** Идентификатор шаблона бизнес-процесса. */
+    ID: number;
+}

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/crm/index.d.ts

@@ -14,3 +14,4 @@ export * from './duplicate';
 export * from './entity';
 export * from './calllist';
 export * from './requisite';
+export * from './timeline';

package/typification/rest/crm/timeline/bindings.d.ts

@@ -0,0 +1,33 @@
+import { iBXRestCrmFieldDescription } from '../enum';
+/** Связь записи таймлайна с элементом CRM. */
+export interface iBXRestCrmTimelineBinding {
+    /** Идентификатор записи таймлайна. */
+    OWNER_ID: string;
+    /** Идентификатор связанного элемента CRM. */
+    ENTITY_ID: string;
+    /** Тип элемента CRM: `lead`, `deal`, `contact`, `company` или `order`. */
+    ENTITY_TYPE: string;
+}
+/** Поля для добавления или удаления связи записи таймлайна. */
+export interface iBXRestCrmTimelineBindingFields {
+    /** Идентификатор записи таймлайна. */
+    OWNER_ID: number;
+    /** Идентификатор элемента CRM. */
+    ENTITY_ID: number;
+    /** Тип элемента CRM: `lead`, `deal`, `contact`, `company` или `order`. */
+    ENTITY_TYPE: string;
+}
+/** Параметры добавления или удаления связи записи таймлайна. */
+export interface iBXRestParamCrmTimelineBindingChange {
+    /** Поля связи. */
+    fields: iBXRestCrmTimelineBindingFields;
+}
+/** Параметры получения связей записи таймлайна. */
+export interface iBXRestParamCrmTimelineBindingList {
+    /** Фильтр с обязательным идентификатором записи таймлайна. */
+    filter: {
+        OWNER_ID: number;
+    };
+}
+/** Описание полей связи, возвращаемое `crm.timeline.bindings.fields`. */
+export type iBXRestCrmTimelineBindingFieldsDescription = Record<keyof iBXRestCrmTimelineBinding, iBXRestCrmFieldDescription>;

package/typification/rest/crm/timeline/comment.d.ts

@@ -0,0 +1,122 @@
+import { iBXRestPagination } from '../../base/api-pagination-bx';
+import { iBXRestCrmFieldDescription } from '../enum';
+import { iBXRestCrmTimelineAttachedFile, iBXRestCrmTimelineSortOrder } from './common';
+/** Изображение, если прикрепленный к комментарию файл является картинкой. */
+export interface iBXRestCrmTimelineCommentFileImage {
+    /** Ширина изображения в пикселях. */
+    width: number;
+    /** Высота изображения в пикселях. */
+    height: number;
+}
+/** Файл, прикрепленный к комментарию таймлайна. */
+export interface iBXRestCrmTimelineCommentFile {
+    /** Идентификатор файла. */
+    id: number;
+    /** Дата и время добавления в формате ISO 8601. */
+    date: string;
+    /** Тип файла, например `image`. */
+    type: string;
+    /** Имя файла. */
+    name: string;
+    /** Размер файла в байтах. */
+    size: number;
+    /** Размеры изображения; присутствуют только у изображений. */
+    image?: iBXRestCrmTimelineCommentFileImage;
+    /** Идентификатор автора файла. */
+    authorId: number;
+    /** Имя автора файла. */
+    authorName: string;
+    /** URL предварительного просмотра. */
+    urlPreview: string;
+    /** URL просмотра файла. */
+    urlShow: string;
+    /** URL скачивания файла. */
+    urlDownload: string;
+}
+/** Комментарий таймлайна в исходном формате REST API. */
+export interface iBXRestCrmTimelineComment {
+    /** Идентификатор комментария. */
+    ID: string;
+    /** Идентификатор элемента CRM. */
+    ENTITY_ID: string;
+    /** Тип элемента CRM: `lead`, `deal`, `contact`, `company`, `order` или `dynamic_*`. */
+    ENTITY_TYPE: string;
+    /** Дата и время создания в формате ISO 8601. */
+    CREATED: string;
+    /** Текст комментария. */
+    COMMENT: string;
+    /** Идентификатор автора. */
+    AUTHOR_ID: string;
+    /** Прикрепленные файлы, индексированные их идентификаторами. */
+    FILES: Record<string, iBXRestCrmTimelineCommentFile>;
+}
+/** Поля нового комментария таймлайна. */
+export interface iBXRestCrmTimelineCommentAddFields {
+    /** Идентификатор элемента CRM. */
+    ENTITY_ID: number;
+    /** Тип элемента CRM: `lead`, `deal`, `contact`, `company`, `order` или `dynamic_*`. */
+    ENTITY_TYPE: string;
+    /** Текст комментария. */
+    COMMENT: string;
+    /** Файлы в формате `[имя, содержимое Base64]`. */
+    FILES?: iBXRestCrmTimelineAttachedFile[];
+}
+/** Параметры `crm.timeline.comment.add`. */
+export interface iBXRestParamCrmTimelineCommentAdd {
+    /**
+     * Поля комментария.
+     *
+     * Ключ должен называться именно `fields` в нижнем регистре.
+     */
+    fields: iBXRestCrmTimelineCommentAddFields;
+}
+/** Изменяемые поля комментария таймлайна. */
+export interface iBXRestCrmTimelineCommentUpdateFields {
+    /** Новый текст комментария. */
+    COMMENT?: string;
+    /** Новый список файлов в формате `[имя, содержимое Base64]`. */
+    FILES?: iBXRestCrmTimelineAttachedFile[];
+}
+/** Параметры `crm.timeline.comment.update`. */
+export interface iBXRestParamCrmTimelineCommentUpdate {
+    /** Идентификатор комментария. */
+    id: number;
+    /**
+     * Изменяемые поля.
+     *
+     * Ключ должен называться именно `fields` в нижнем регистре.
+     */
+    fields: iBXRestCrmTimelineCommentUpdateFields;
+    /** Тип связанного объекта CRM, например `2` для сделки. */
+    ownerTypeId?: number;
+    /** Идентификатор связанного элемента CRM. */
+    ownerId?: number;
+}
+/** Параметры получения комментария. */
+export interface iBXRestParamCrmTimelineCommentGet {
+    /** Идентификатор комментария. */
+    id: number;
+}
+/** Параметры списка комментариев. */
+export interface iBXRestParamCrmTimelineCommentList extends iBXRestPagination {
+    /** Возвращаемые поля. Если не указаны, возвращаются все поля. */
+    select?: (keyof iBXRestCrmTimelineComment)[];
+    /** Обязательная привязка комментариев к элементу CRM. */
+    filter: {
+        /** Идентификатор элемента CRM. */
+        ENTITY_ID: number;
+        /** Тип элемента CRM, например `deal`, `lead`, `contact` или `company`. */
+        ENTITY_TYPE: string;
+    };
+    /** Сортировка по `ID`, `CREATED` и/или `AUTHOR_ID`. */
+    order?: Partial<Record<'ID' | 'CREATED' | 'AUTHOR_ID', iBXRestCrmTimelineSortOrder>>;
+}
+/** Параметры удаления комментария. */
+export interface iBXRestParamCrmTimelineCommentDelete extends iBXRestParamCrmTimelineCommentGet {
+    /** Тип связанного объекта CRM. Позволяет удалить только указанную привязку. */
+    ownerTypeId?: number;
+    /** Идентификатор связанного элемента CRM. Используется вместе с `ownerTypeId`. */
+    ownerId?: number;
+}
+/** Описание полей комментария, возвращаемое `crm.timeline.comment.fields`. */
+export type iBXRestCrmTimelineCommentFields = Record<keyof iBXRestCrmTimelineComment, iBXRestCrmFieldDescription>;

package/typification/rest/crm/timeline/common.d.ts

@@ -0,0 +1,31 @@
+/** Допустимое направление сортировки в методах таймлайна CRM. */
+export type iBXRestCrmTimelineSortOrder = 'ASC' | 'DESC' | 'asc' | 'desc';
+/**
+ * Файл для загрузки в комментарий таймлайна.
+ *
+ * Первый элемент — имя файла, второй — его содержимое в Base64.
+ */
+export type iBXRestCrmTimelineAttachedFile = [fileName: string, base64Content: string];
+/** Описание пользовательской иконки или логотипа лог-записи. */
+export interface iBXRestCrmTimelineMedia {
+    /** Уникальный код ресурса. */
+    code: string;
+    /** `true` для встроенного ресурса Битрикс24, `false` для добавленного приложением. */
+    isSystem: boolean;
+    /** Путь к загруженному файлу; для системного ресурса обычно пустая строка. */
+    fileUri: string;
+}
+/** Параметр метода, принимающего код иконки или логотипа. */
+export interface iBXRestParamCrmTimelineMediaGet {
+    /** Код ресурса. Список кодов возвращают методы `list`. */
+    code: string;
+}
+/** Параметры добавления пользовательской иконки или логотипа. */
+export interface iBXRestParamCrmTimelineMediaAdd extends iBXRestParamCrmTimelineMediaGet {
+    /** Содержимое PNG-файла в Base64. */
+    fileContent: string;
+}
+/** Результат операции над дополнительными контентными блоками. */
+export interface iBXRestCrmTimelineSuccessResult {
+    success: true;
+}

package/typification/rest/crm/timeline/icon.d.ts

@@ -0,0 +1,9 @@
+import { iBXRestCrmTimelineMedia } from './common';
+/** Результат добавления или получения иконки лог-записи. */
+export interface iBXRestCrmTimelineIconResult {
+    icon: iBXRestCrmTimelineMedia;
+}
+/** Результат получения списка доступных иконок. */
+export interface iBXRestCrmTimelineIconListResult {
+    icons: iBXRestCrmTimelineMedia[];
+}

package/typification/rest/crm/timeline/index.d.ts

@@ -0,0 +1,9 @@
+export * from './common';
+export * from './comment';
+export * from './note';
+export * from './bindings';
+export * from './layout';
+export * from './logmessage';
+export * from './icon';
+export * from './logo';
+export * from './item';

package/typification/rest/crm/timeline/item.d.ts

@@ -0,0 +1,9 @@
+/** Параметры закрепления или открепления записи таймлайна. */
+export interface iBXRestParamCrmTimelineItemPin {
+    /** Идентификатор записи таймлайна. */
+    id: number;
+    /** Идентификатор типа связанного объекта CRM, например `2` для сделки. */
+    ownerTypeId: number;
+    /** Идентификатор связанного элемента CRM. */
+    ownerId: number;
+}

package/typification/rest/crm/timeline/layout.d.ts

@@ -0,0 +1,34 @@
+/** Один дополнительный контентный блок записи таймлайна. */
+export interface iBXRestCrmTimelineLayoutBlock {
+    /** Тип блока, например `text`, `largeText`, `link` или `withTitle`. */
+    type: string;
+    /** Свойства блока. Их состав зависит от значения `type`. */
+    properties: Record<string, unknown>;
+}
+/** Набор дополнительных контентных блоков, установленный приложением. */
+export interface iBXRestCrmTimelineLayout {
+    /**
+     * Блоки, индексированные произвольными уникальными ключами приложения.
+     *
+     * При повторном вызове `set` весь набор этого приложения заменяется.
+     */
+    blocks: Record<string, iBXRestCrmTimelineLayoutBlock>;
+}
+/** Адрес записи таймлайна для методов `crm.timeline.layout.blocks.*`. */
+export interface iBXRestParamCrmTimelineLayoutBlocks {
+    /** Идентификатор типа CRM-объекта. */
+    entityTypeId: number;
+    /** Идентификатор CRM-элемента. */
+    entityId: number;
+    /** Идентификатор записи таймлайна. */
+    timelineId: number;
+}
+/** Параметры установки дополнительных контентных блоков. */
+export interface iBXRestParamCrmTimelineLayoutBlocksSet extends iBXRestParamCrmTimelineLayoutBlocks {
+    /** Новый полный набор блоков приложения. */
+    layout: iBXRestCrmTimelineLayout;
+}
+/** Результат чтения дополнительных контентных блоков. */
+export interface iBXRestCrmTimelineLayoutResult {
+    layout: iBXRestCrmTimelineLayout;
+}