bx-rest 0.10.6 → 0.10.7

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

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

@@ -0,0 +1,52 @@
+import { iBXRestPagination } from '../../base/api-pagination-bx';
+import { iBXRestCrmTimelineSortOrder } from './common';
+/** Лог-запись приложения в таймлайне CRM. */
+export interface iBXRestCrmTimelineLogMessage {
+    /** Идентификатор записи таймлайна. */
+    id: number;
+    /** Дата и время создания в формате ISO 8601. */
+    created: string;
+    /** Идентификатор автора. */
+    authorId: number;
+    /** Заголовок записи. */
+    title: string;
+    /** Текст записи. */
+    text: string;
+    /** Код иконки из `crm.timeline.icon.list`. */
+    iconCode: string;
+}
+/** Поля новой лог-записи. */
+export interface iBXRestCrmTimelineLogMessageAddFields {
+    /** Идентификатор типа CRM-сущности. */
+    entityTypeId: number;
+    /** Идентификатор элемента CRM. */
+    entityId: number;
+    /** Заголовок записи. */
+    title: string;
+    /** Текст записи. */
+    text: string;
+    /** Код иконки из `crm.timeline.icon.list`. */
+    iconCode: string;
+}
+/** Параметры добавления лог-записи. */
+export interface iBXRestParamCrmTimelineLogMessageAdd {
+    fields: iBXRestCrmTimelineLogMessageAddFields;
+}
+/** Параметры получения или удаления лог-записи. */
+export interface iBXRestParamCrmTimelineLogMessageGet {
+    /** Идентификатор лог-записи. */
+    id: number;
+}
+/** Параметры списка лог-записей приложения. */
+export interface iBXRestParamCrmTimelineLogMessageList extends iBXRestPagination {
+    /** Идентификатор типа CRM-сущности. */
+    entityTypeId: number;
+    /** Идентификатор элемента CRM. */
+    entityId: number;
+    /** Сортировка по идентификатору и/или дате создания. */
+    order?: Partial<Record<'id' | 'created', iBXRestCrmTimelineSortOrder>>;
+}
+/** Контейнер лог-записи в ответах `add` и `get`. */
+export interface iBXRestCrmTimelineLogMessageResult {
+    logMessage: iBXRestCrmTimelineLogMessage;
+}

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

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

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

@@ -0,0 +1,31 @@
+/** Тип записи, к которой относится заметка. */
+export type iBXRestCrmTimelineNoteItemType = 1 | 2;
+/** Общие параметры методов заметок таймлайна. */
+export interface iBXRestParamCrmTimelineNote {
+    /** Идентификатор типа CRM-элемента, к которому относится запись. */
+    ownerTypeId: number;
+    /** Идентификатор CRM-элемента, к которому относится запись. */
+    ownerId: number;
+    /** `1` — запись истории таймлайна, `2` — дело CRM. */
+    itemType: iBXRestCrmTimelineNoteItemType;
+    /** Идентификатор записи истории или дела — в зависимости от `itemType`. */
+    itemId: number;
+}
+/** Параметры сохранения заметки. */
+export interface iBXRestParamCrmTimelineNoteSave extends iBXRestParamCrmTimelineNote {
+    /** Текст заметки. Повторный вызов обновляет существующую заметку. */
+    text: string;
+}
+/** Заметка к записи таймлайна или делу CRM. */
+export interface iBXRestCrmTimelineNote {
+    /** Текст заметки. */
+    text: string;
+    /** Идентификатор создавшего заметку пользователя. */
+    createdById: number;
+    /** Дата и время создания в формате ISO 8601. */
+    createdTime: string;
+    /** Идентификатор последнего изменившего заметку пользователя. */
+    updatedById: number;
+    /** Дата и время последнего изменения в формате ISO 8601. */
+    updatedTime: string;
+}