bx-rest 0.10.6 → 0.10.7

package/fesm2022/bx-rest.mjs

@@ -1056,6 +1056,19 @@ const $numerator = 'numerator';
 const $document = 'document';
 const $enablepublicurl = 'enablepublicurl';
 const $upload = 'upload';
+const $timeline = 'timeline';
+const $comment = 'comment';
+const $note = 'note';
+const $bindings = 'bindings';
+const $bind = 'bind';
+const $unbind = 'unbind';
+const $layout = 'layout';
+const $blocks = 'blocks';
+const $logmessage = 'logmessage';
+const $icon = 'icon';
+const $logo = 'logo';
+const $save = 'save';
+const $unpin = 'unpin';
 
 var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     __proto__: null,
@@ -1073,7 +1086,10 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $automation: $automation,
     $availabletoadd: $availabletoadd,
     $bankdetail: $bankdetail,
+    $bind: $bind,
+    $bindings: $bindings,
     $bizproc: $bizproc,
+    $blocks: $blocks,
     $blogcomment: $blogcomment,
     $blogpost: $blogpost,
     $booking: $booking,
@@ -1081,6 +1097,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $calllist: $calllist,
     $channel: $channel,
     $chat: $chat,
+    $comment: $comment,
     $commentitem: $commentitem,
     $company: $company,
     $complete: $complete,
@@ -1128,6 +1145,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $hide: $hide,
     $history: $history,
     $iblock: $iblock,
+    $icon: $icon,
     $id: $id,
     $idle: $idle,
     $im: $im,
@@ -1136,12 +1154,15 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $item: $item,
     $items: $items,
     $kill: $kill,
+    $layout: $layout,
     $lead: $lead,
     $leave: $leave,
     $link: $link,
     $list: $list,
     $lists: $lists,
     $log: $log,
+    $logmessage: $logmessage,
+    $logo: $logo,
     $markdeleted: $markdeleted,
     $meeting: $meeting,
     $mergeBatch: $mergeBatch,
@@ -1151,6 +1172,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $multifield: $multifield,
     $mute: $mute,
     $nearest: $nearest,
+    $note: $note,
     $numerator: $numerator,
     $params: $params,
     $pause: $pause,
@@ -1172,6 +1194,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $restore: $restore,
     $result: $result,
     $robot: $robot,
+    $save: $save,
     $search: $search,
     $section: $section,
     $send: $send,
@@ -1193,8 +1216,11 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $terminate: $terminate,
     $time: $time,
     $timeMan: $timeMan,
+    $timeline: $timeline,
     $trigger: $trigger,
     $type: $type,
+    $unbind: $unbind,
+    $unpin: $unpin,
     $unread: $unread,
     $unregister: $unregister,
     $update: $update,
@@ -2284,7 +2310,7 @@ class NavvyPag extends NavvyPagBase {
             if (items && instanceOfiBXRestAnswerSuccess(items)) {
                 this.save = [];
                 // TODO: проверить будет ли быстрее работать метод в случаях когда total < 100 (то есть можно обойтись двумя прямыми запросами)
-                if (items.total && items.total > 50) {
+                if (items.total && items.total > this.pageSize) {
                     const mathFloor = Math.floor(items.total / this.pageSize);
                     const count = (mathFloor === items.total / this.pageSize) // если mathFloor равен обычному делению, значит один запрос будет лишним, так как результат первой страницы уже есть, а последняя в данном случаи будет пустая (или с мусорными аднными)
                         ? [...Array(mathFloor - 1).keys()]
@@ -8168,8 +8194,451 @@ class BXRestNavvyCrmRequisite {
     }
 }
 
+/** Связи записей таймлайна с элементами CRM (`crm.timeline.bindings.*`). */
+class BXRestNavvyCrmTimelineBindings {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Добавляет связь записи таймлайна с элементом CRM. */
+            bind: [$crm, $timeline, $bindings, $bind],
+            /** Возвращает все связи записи таймлайна. */
+            list: [$crm, $timeline, $bindings, $list],
+            /** Удаляет связь записи таймлайна с элементом CRM. */
+            unbind: [$crm, $timeline, $bindings, $unbind],
+            /** Возвращает описание полей связи. */
+            fields: [$crm, $timeline, $bindings, 'fields']
+        };
+    }
+    /**
+     * Добавляет связь записи таймлайна с элементом CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-bind.html
+     */
+    bind(param) {
+        return this.Navvy.simple(this.url.bind, param);
+    }
+    /**
+     * Возвращает все связи записи таймлайна по обязательному `OWNER_ID`.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-list.html
+     */
+    list(param) {
+        return this.Navvy.simple(this.url.list, param);
+    }
+    /**
+     * Удаляет связь записи таймлайна с указанным элементом CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-unbind.html
+     */
+    unbind(param) {
+        return this.Navvy.simple(this.url.unbind, param);
+    }
+    /**
+     * Возвращает описание полей связи записи таймлайна с элементом CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-fields.html
+     */
+    fields() {
+        return this.Navvy.simple(this.url.fields);
+    }
+}
+
+/** Комментарии таймлайна (`crm.timeline.comment.*`). */
+class BXRestNavvyCrmTimelineComment {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Добавляет новый комментарий в таймлайн. */
+            add: [$crm, $timeline, $comment, $add],
+            /** Обновляет текст и/или файлы комментария. */
+            update: [$crm, $timeline, $comment, $update],
+            /** Возвращает комментарий по идентификатору. */
+            get: [$crm, $timeline, $comment, $get],
+            /** Возвращает комментарии указанного элемента CRM. */
+            list: [$crm, $timeline, $comment, $list],
+            /** Удаляет комментарий или его отдельную привязку. */
+            delete: [$crm, $timeline, $comment, $delete],
+            /** Возвращает формальное описание полей комментария. */
+            fields: [$crm, $timeline, $comment, 'fields']
+        };
+    }
+    /**
+     * Добавляет новый комментарий в таймлайн элемента CRM.
+     *
+     * Содержимое файлов передается в Base64. Начиная с CRM 23.100.0 внешний ключ
+     * параметров должен называться именно `fields` в нижнем регистре.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-add.html
+     */
+    add(param) {
+        return this.Navvy.simple(this.url.add, param);
+    }
+    /**
+     * Обновляет текст и/или прикрепленные файлы комментария.
+     *
+     * `ownerTypeId` и `ownerId` уточняют элемент CRM, когда комментарий связан
+     * сразу с несколькими элементами.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-update.html
+     */
+    update(param) {
+        return this.Navvy.simple(this.url.update, param);
+    }
+    /**
+     * Возвращает комментарий по его идентификатору.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-get.html
+     */
+    get(param) {
+        return this.Navvy.simple(this.url.get, param);
+    }
+    /**
+     * Возвращает комментарии указанного элемента CRM с выборкой полей,
+     * сортировкой и постраничной навигацией.
+     *
+     * Размер страницы REST API фиксирован и равен 50 записям.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-list.html
+     */
+    list(param) {
+        return this.Navvy.pagNav(this.url.list, param);
+    }
+    /**
+     * Удаляет комментарий.
+     *
+     * Если передать `ownerTypeId` и `ownerId`, у комментария с несколькими
+     * связями будет удалена только привязка к указанному элементу.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+    /**
+     * Возвращает описание всех полей комментария таймлайна.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-fields.html
+     */
+    fields() {
+        return this.Navvy.simple(this.url.fields);
+    }
+}
+
+/** Иконки лог-записей (`crm.timeline.icon.*`). */
+class BXRestNavvyCrmTimelineIcon {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Добавляет пользовательскую иконку. */
+            add: [$crm, $timeline, $icon, $add],
+            /** Возвращает иконку по коду. */
+            get: [$crm, $timeline, $icon, $get],
+            /** Возвращает системные и пользовательские иконки. */
+            list: [$crm, $timeline, $icon, $list],
+            /** Удаляет пользовательскую иконку. */
+            delete: [$crm, $timeline, $icon, $delete]
+        };
+    }
+    /**
+     * Добавляет пользовательскую иконку лог-записи.
+     *
+     * Метод доступен только администратору. Передайте прозрачный PNG 24×24 пикселя
+     * в виде Base64-строки.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-add.html
+     */
+    add(param) {
+        return this.Navvy.simple(this.url.add, param);
+    }
+    /**
+     * Возвращает системную или пользовательскую иконку по коду.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-get.html
+     */
+    get(param) {
+        return this.Navvy.simple(this.url.get, param);
+    }
+    /**
+     * Возвращает список всех доступных системных и пользовательских иконок.
+     *
+     * Поле `isSystem` отличает встроенную иконку от добавленной приложением.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-list.html
+     */
+    list() {
+        return this.Navvy.simple(this.url.list);
+    }
+    /**
+     * Удаляет пользовательскую иконку. Системные иконки удалить нельзя.
+     *
+     * Метод доступен только администратору.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+}
+
+/** Действия над записями таймлайна (`crm.timeline.item.*`). */
+class BXRestNavvyCrmTimelineItem {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Закрепляет запись в таймлайне элемента CRM. */
+            pin: [$crm, $timeline, $item, $pin],
+            /** Открепляет запись в таймлайне элемента CRM. */
+            unpin: [$crm, $timeline, $item, $unpin]
+        };
+    }
+    /**
+     * Закрепляет запись в таймлайне указанного элемента CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/timeline-item/crm-timeline-item-pin.html
+     */
+    pin(param) {
+        return this.Navvy.simple(this.url.pin, param);
+    }
+    /**
+     * Открепляет запись в таймлайне указанного элемента CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/timeline-item/crm-timeline-item-unpin.html
+     */
+    unpin(param) {
+        return this.Navvy.simple(this.url.unpin, param);
+    }
+}
+
+/** Дополнительные контентные блоки записи таймлайна (`crm.timeline.layout.blocks.*`). */
+class BXRestNavvyCrmTimelineLayoutBlocks {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Устанавливает полный набор блоков текущего приложения. */
+            set: [$crm, $timeline, $layout, $blocks, $set],
+            /** Возвращает набор блоков текущего приложения. */
+            get: [$crm, $timeline, $layout, $blocks, $get],
+            /** Удаляет набор блоков текущего приложения. */
+            delete: [$crm, $timeline, $layout, $blocks, $delete]
+        };
+    }
+    /**
+     * Устанавливает набор дополнительных контентных блоков в запись таймлайна.
+     *
+     * Новый вызов полностью заменяет набор, ранее установленный тем же приложением.
+     * Метод доступен администратору и не применяется к делам, лог-записям и
+     * устаревшим типам записей таймлайна.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/layout/blocks/crm-timeline-layout-blocks-set.html
+     */
+    set(param) {
+        return this.Navvy.simple(this.url.set, param);
+    }
+    /**
+     * Возвращает набор дополнительных контентных блоков, установленный текущим приложением.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/layout/blocks/crm-timeline-layout-blocks-get.html
+     */
+    get(param) {
+        return this.Navvy.simple(this.url.get, param);
+    }
+    /**
+     * Удаляет набор дополнительных контентных блоков текущего приложения.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/layout/blocks/crm-timeline-layout-blocks-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+}
+
+/** Визуальное расширение записей таймлайна (`crm.timeline.layout.*`). */
+class BXRestNavvyCrmTimelineLayout {
+    constructor() {
+        /** Дополнительные контентные блоки записи. */
+        this.blocks = new BXRestNavvyCrmTimelineLayoutBlocks();
+    }
+}
+
+/** Лог-записи приложения в таймлайне (`crm.timeline.logmessage.*`). */
+class BXRestNavvyCrmTimelineLogMessage {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Добавляет лог-запись приложения. */
+            add: [$crm, $timeline, $logmessage, $add],
+            /** Возвращает лог-запись по идентификатору. */
+            get: [$crm, $timeline, $logmessage, $get],
+            /** Возвращает лог-записи приложения для элемента CRM. */
+            list: [$crm, $timeline, $logmessage, $list],
+            /** Удаляет лог-запись приложения. */
+            delete: [$crm, $timeline, $logmessage, $delete]
+        };
+    }
+    /**
+     * Добавляет новую лог-запись приложения в таймлайн элемента CRM.
+     *
+     * Значение `iconCode` должно присутствовать в результате `crm.timeline.icon.list`.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-add.html
+     */
+    add(param) {
+        return this.Navvy.simple(this.url.add, param);
+    }
+    /**
+     * Возвращает лог-запись, ранее добавленную приложением.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-get.html
+     */
+    get(param) {
+        return this.Navvy.simple(this.url.get, param);
+    }
+    /**
+     * Возвращает лог-записи приложения для указанного элемента CRM.
+     *
+     * Системные записи метод не возвращает. Размер страницы REST API фиксирован
+     * и равен 10 записям; `resAll()` учитывает этот размер.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-list.html
+     */
+    list(param) {
+        const request = this.Navvy.pagNav(this.url.list, param);
+        request.pageSize = 10;
+        return request;
+    }
+    /**
+     * Удаляет лог-запись, ранее добавленную приложением.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+}
+
+/** Логотипы лог-записей (`crm.timeline.logo.*`). */
+class BXRestNavvyCrmTimelineLogo {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Добавляет пользовательский логотип. */
+            add: [$crm, $timeline, $logo, $add],
+            /** Возвращает логотип по коду. */
+            get: [$crm, $timeline, $logo, $get],
+            /** Возвращает системные и пользовательские логотипы. */
+            list: [$crm, $timeline, $logo, $list],
+            /** Удаляет пользовательский логотип. */
+            delete: [$crm, $timeline, $logo, $delete]
+        };
+    }
+    /**
+     * Добавляет пользовательский логотип лог-записи.
+     *
+     * Метод доступен только администратору. Передайте прозрачный PNG 60×60 пикселей
+     * в виде Base64-строки.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-add.html
+     */
+    add(param) {
+        return this.Navvy.simple(this.url.add, param);
+    }
+    /**
+     * Возвращает системный или пользовательский логотип по коду.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-get.html
+     */
+    get(param) {
+        return this.Navvy.simple(this.url.get, param);
+    }
+    /**
+     * Возвращает список всех доступных системных и пользовательских логотипов.
+     *
+     * Поле `isSystem` отличает встроенный логотип от добавленного приложением.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-list.html
+     */
+    list() {
+        return this.Navvy.simple(this.url.list);
+    }
+    /**
+     * Удаляет пользовательский логотип. Системные логотипы удалить нельзя.
+     *
+     * Метод доступен только администратору.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+}
+
+/** Заметки к записям таймлайна и делам (`crm.timeline.note.*`). */
+class BXRestNavvyCrmTimelineNote {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Возвращает заметку к записи таймлайна или делу. */
+            get: [$crm, $timeline, $note, $get],
+            /** Создает или обновляет заметку. */
+            save: [$crm, $timeline, $note, $save],
+            /** Удаляет заметку. */
+            delete: [$crm, $timeline, $note, $delete]
+        };
+    }
+    /**
+     * Возвращает заметку к записи истории таймлайна или делу CRM.
+     *
+     * В `itemType` передайте `1` для записи истории или `2` для дела.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-get.html
+     */
+    get(param) {
+        return this.Navvy.simple(this.url.get, param);
+    }
+    /**
+     * Создает заметку или заменяет текст существующей.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-save.html
+     */
+    save(param) {
+        return this.Navvy.simple(this.url.save, param);
+    }
+    /**
+     * Удаляет заметку у записи истории таймлайна или дела CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+}
+
+/** Таймлайн CRM: комментарии, заметки, связи и лог-записи (`crm.timeline.*`). */
+class BXRestNavvyCrmTimeline {
+    constructor() {
+        /** Комментарии таймлайна. */
+        this.comment = new BXRestNavvyCrmTimelineComment();
+        /** Заметки к записям таймлайна и делам. */
+        this.note = new BXRestNavvyCrmTimelineNote();
+        /** Связи записей таймлайна с элементами CRM. */
+        this.bindings = new BXRestNavvyCrmTimelineBindings();
+        /** Дополнительные контентные блоки записей. */
+        this.layout = new BXRestNavvyCrmTimelineLayout();
+        /** Лог-записи приложения. */
+        this.logMessage = new BXRestNavvyCrmTimelineLogMessage();
+        /** Иконки лог-записей. */
+        this.icon = new BXRestNavvyCrmTimelineIcon();
+        /** Логотипы лог-записей. */
+        this.logo = new BXRestNavvyCrmTimelineLogo();
+        /** Закрепление и открепление записей. */
+        this.item = new BXRestNavvyCrmTimelineItem();
+    }
+}
+
 class BXRestNavvyCrm {
     constructor() {
+        /** Таймлайн CRM: комментарии, заметки, связи и лог-записи (`crm.timeline.*`). */
+        this.timeline = new BXRestNavvyCrmTimeline();
         /** Адреса CRM, в том числе адреса реквизитов (`crm.address.*`). */
         this.address = new BXRestNavvyCrmAddress();
         /** Реквизиты, банковские данные, связи и шаблоны (`crm.requisite.*`). */