bx-rest 0.10.6 → 0.10.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/consts/part-name-methods.d.ts +13 -0
  2. package/esm2022/consts/part-name-methods.mjs +14 -1
  3. package/esm2022/request-navvy/crm/timeline/bindings.mjs +51 -0
  4. package/esm2022/request-navvy/crm/timeline/comment.mjs +83 -0
  5. package/esm2022/request-navvy/crm/timeline/icon.mjs +58 -0
  6. package/esm2022/request-navvy/crm/timeline/index.mjs +38 -0
  7. package/esm2022/request-navvy/crm/timeline/item.mjs +31 -0
  8. package/esm2022/request-navvy/crm/timeline/layout/blocks.mjs +45 -0
  9. package/esm2022/request-navvy/crm/timeline/layout/index.mjs +10 -0
  10. package/esm2022/request-navvy/crm/timeline/logmessage.mjs +58 -0
  11. package/esm2022/request-navvy/crm/timeline/logo.mjs +58 -0
  12. package/esm2022/request-navvy/crm/timeline/note.mjs +43 -0
  13. package/esm2022/request-navvy/crm.mjs +4 -1
  14. package/esm2022/services/navvy/navvy-pag.mjs +2 -2
  15. package/esm2022/typification/rest/crm/index.mjs +2 -1
  16. package/esm2022/typification/rest/crm/timeline/bindings.mjs +2 -0
  17. package/esm2022/typification/rest/crm/timeline/comment.mjs +2 -0
  18. package/esm2022/typification/rest/crm/timeline/common.mjs +2 -0
  19. package/esm2022/typification/rest/crm/timeline/icon.mjs +2 -0
  20. package/esm2022/typification/rest/crm/timeline/index.mjs +10 -0
  21. package/esm2022/typification/rest/crm/timeline/item.mjs +2 -0
  22. package/esm2022/typification/rest/crm/timeline/layout.mjs +2 -0
  23. package/esm2022/typification/rest/crm/timeline/logmessage.mjs +2 -0
  24. package/esm2022/typification/rest/crm/timeline/logo.mjs +2 -0
  25. package/esm2022/typification/rest/crm/timeline/note.mjs +2 -0
  26. package/fesm2022/bx-rest.mjs +470 -1
  27. package/fesm2022/bx-rest.mjs.map +1 -1
  28. package/package.json +1 -1
  29. package/request-navvy/crm/timeline/bindings.d.ts +39 -0
  30. package/request-navvy/crm/timeline/comment.d.ts +67 -0
  31. package/request-navvy/crm/timeline/icon.d.ts +46 -0
  32. package/request-navvy/crm/timeline/index.d.ts +35 -0
  33. package/request-navvy/crm/timeline/item.d.ts +23 -0
  34. package/request-navvy/crm/timeline/layout/blocks.d.ts +35 -0
  35. package/request-navvy/crm/timeline/layout/index.d.ts +7 -0
  36. package/request-navvy/crm/timeline/logmessage.d.ts +44 -0
  37. package/request-navvy/crm/timeline/logo.d.ts +46 -0
  38. package/request-navvy/crm/timeline/note.d.ts +33 -0
  39. package/request-navvy/crm.d.ts +3 -0
  40. package/typification/rest/crm/index.d.ts +1 -0
  41. package/typification/rest/crm/timeline/bindings.d.ts +33 -0
  42. package/typification/rest/crm/timeline/comment.d.ts +122 -0
  43. package/typification/rest/crm/timeline/common.d.ts +31 -0
  44. package/typification/rest/crm/timeline/icon.d.ts +9 -0
  45. package/typification/rest/crm/timeline/index.d.ts +9 -0
  46. package/typification/rest/crm/timeline/item.d.ts +9 -0
  47. package/typification/rest/crm/timeline/layout.d.ts +34 -0
  48. package/typification/rest/crm/timeline/logmessage.d.ts +52 -0
  49. package/typification/rest/crm/timeline/logo.d.ts +9 -0
  50. package/typification/rest/crm/timeline/note.d.ts +31 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bx-rest",
3
- "version": "0.10.6",
3
+ "version": "0.10.7",
4
4
  "description": "Bitrix24 REST API client and TypeScript SDK for Angular, Vue and browser apps",
5
5
  "keywords": [
6
6
  "bitrix",
@@ -0,0 +1,39 @@
1
+ import { iBXRestCrmTimelineBinding, iBXRestCrmTimelineBindingFieldsDescription, iBXRestParamCrmTimelineBindingChange, iBXRestParamCrmTimelineBindingList } from '../../../typification/rest/crm';
2
+ /** Связи записей таймлайна с элементами CRM (`crm.timeline.bindings.*`). */
3
+ export declare class BXRestNavvyCrmTimelineBindings {
4
+ private readonly Navvy;
5
+ readonly url: {
6
+ /** Добавляет связь записи таймлайна с элементом CRM. */
7
+ bind: string[];
8
+ /** Возвращает все связи записи таймлайна. */
9
+ list: string[];
10
+ /** Удаляет связь записи таймлайна с элементом CRM. */
11
+ unbind: string[];
12
+ /** Возвращает описание полей связи. */
13
+ fields: string[];
14
+ };
15
+ /**
16
+ * Добавляет связь записи таймлайна с элементом CRM.
17
+ *
18
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-bind.html
19
+ */
20
+ bind(param: iBXRestParamCrmTimelineBindingChange): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmTimelineBindingChange | undefined>;
21
+ /**
22
+ * Возвращает все связи записи таймлайна по обязательному `OWNER_ID`.
23
+ *
24
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-list.html
25
+ */
26
+ list(param: iBXRestParamCrmTimelineBindingList): import("../../../services/navvy").NavvySimple<iBXRestCrmTimelineBinding[], iBXRestCrmTimelineBinding[], iBXRestParamCrmTimelineBindingList | undefined>;
27
+ /**
28
+ * Удаляет связь записи таймлайна с указанным элементом CRM.
29
+ *
30
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-unbind.html
31
+ */
32
+ unbind(param: iBXRestParamCrmTimelineBindingChange): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmTimelineBindingChange | undefined>;
33
+ /**
34
+ * Возвращает описание полей связи записи таймлайна с элементом CRM.
35
+ *
36
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-fields.html
37
+ */
38
+ fields(): import("../../../services/navvy").NavvySimple<iBXRestCrmTimelineBindingFieldsDescription, iBXRestCrmTimelineBindingFieldsDescription, undefined>;
39
+ }
@@ -0,0 +1,67 @@
1
+ import { iBXRestCrmTimelineComment, iBXRestCrmTimelineCommentFields, iBXRestParamCrmTimelineCommentAdd, iBXRestParamCrmTimelineCommentDelete, iBXRestParamCrmTimelineCommentGet, iBXRestParamCrmTimelineCommentList, iBXRestParamCrmTimelineCommentUpdate } from '../../../typification/rest/crm';
2
+ /** Комментарии таймлайна (`crm.timeline.comment.*`). */
3
+ export declare class BXRestNavvyCrmTimelineComment {
4
+ private readonly Navvy;
5
+ readonly url: {
6
+ /** Добавляет новый комментарий в таймлайн. */
7
+ add: string[];
8
+ /** Обновляет текст и/или файлы комментария. */
9
+ update: string[];
10
+ /** Возвращает комментарий по идентификатору. */
11
+ get: string[];
12
+ /** Возвращает комментарии указанного элемента CRM. */
13
+ list: string[];
14
+ /** Удаляет комментарий или его отдельную привязку. */
15
+ delete: string[];
16
+ /** Возвращает формальное описание полей комментария. */
17
+ fields: string[];
18
+ };
19
+ /**
20
+ * Добавляет новый комментарий в таймлайн элемента CRM.
21
+ *
22
+ * Содержимое файлов передается в Base64. Начиная с CRM 23.100.0 внешний ключ
23
+ * параметров должен называться именно `fields` в нижнем регистре.
24
+ *
25
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-add.html
26
+ */
27
+ add(param: iBXRestParamCrmTimelineCommentAdd): import("../../../services/navvy").NavvySimple<number, number, iBXRestParamCrmTimelineCommentAdd | undefined>;
28
+ /**
29
+ * Обновляет текст и/или прикрепленные файлы комментария.
30
+ *
31
+ * `ownerTypeId` и `ownerId` уточняют элемент CRM, когда комментарий связан
32
+ * сразу с несколькими элементами.
33
+ *
34
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-update.html
35
+ */
36
+ update(param: iBXRestParamCrmTimelineCommentUpdate): import("../../../services/navvy").NavvySimple<number, number, iBXRestParamCrmTimelineCommentUpdate | undefined>;
37
+ /**
38
+ * Возвращает комментарий по его идентификатору.
39
+ *
40
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-get.html
41
+ */
42
+ get(param: iBXRestParamCrmTimelineCommentGet): import("../../../services/navvy").NavvySimple<iBXRestCrmTimelineComment, iBXRestCrmTimelineComment, iBXRestParamCrmTimelineCommentGet | undefined>;
43
+ /**
44
+ * Возвращает комментарии указанного элемента CRM с выборкой полей,
45
+ * сортировкой и постраничной навигацией.
46
+ *
47
+ * Размер страницы REST API фиксирован и равен 50 записям.
48
+ *
49
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-list.html
50
+ */
51
+ list(param: iBXRestParamCrmTimelineCommentList): import("../../../services/navvy").NavvyPag<iBXRestCrmTimelineComment, iBXRestCrmTimelineComment, iBXRestParamCrmTimelineCommentList>;
52
+ /**
53
+ * Удаляет комментарий.
54
+ *
55
+ * Если передать `ownerTypeId` и `ownerId`, у комментария с несколькими
56
+ * связями будет удалена только привязка к указанному элементу.
57
+ *
58
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-delete.html
59
+ */
60
+ delete(param: iBXRestParamCrmTimelineCommentDelete): import("../../../services/navvy").NavvySimple<null, null, iBXRestParamCrmTimelineCommentDelete | undefined>;
61
+ /**
62
+ * Возвращает описание всех полей комментария таймлайна.
63
+ *
64
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-fields.html
65
+ */
66
+ fields(): import("../../../services/navvy").NavvySimple<iBXRestCrmTimelineCommentFields, iBXRestCrmTimelineCommentFields, undefined>;
67
+ }
@@ -0,0 +1,46 @@
1
+ import { iBXRestCrmTimelineIconListResult, iBXRestCrmTimelineIconResult, iBXRestParamCrmTimelineMediaAdd, iBXRestParamCrmTimelineMediaGet } from '../../../typification/rest/crm';
2
+ /** Иконки лог-записей (`crm.timeline.icon.*`). */
3
+ export declare class BXRestNavvyCrmTimelineIcon {
4
+ private readonly Navvy;
5
+ readonly url: {
6
+ /** Добавляет пользовательскую иконку. */
7
+ add: string[];
8
+ /** Возвращает иконку по коду. */
9
+ get: string[];
10
+ /** Возвращает системные и пользовательские иконки. */
11
+ list: string[];
12
+ /** Удаляет пользовательскую иконку. */
13
+ delete: string[];
14
+ };
15
+ /**
16
+ * Добавляет пользовательскую иконку лог-записи.
17
+ *
18
+ * Метод доступен только администратору. Передайте прозрачный PNG 24×24 пикселя
19
+ * в виде Base64-строки.
20
+ *
21
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-add.html
22
+ */
23
+ add(param: iBXRestParamCrmTimelineMediaAdd): import("../../../services/navvy").NavvySimple<iBXRestCrmTimelineIconResult, iBXRestCrmTimelineIconResult, iBXRestParamCrmTimelineMediaAdd | undefined>;
24
+ /**
25
+ * Возвращает системную или пользовательскую иконку по коду.
26
+ *
27
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-get.html
28
+ */
29
+ get(param: iBXRestParamCrmTimelineMediaGet): import("../../../services/navvy").NavvySimple<iBXRestCrmTimelineIconResult, iBXRestCrmTimelineIconResult, iBXRestParamCrmTimelineMediaGet | undefined>;
30
+ /**
31
+ * Возвращает список всех доступных системных и пользовательских иконок.
32
+ *
33
+ * Поле `isSystem` отличает встроенную иконку от добавленной приложением.
34
+ *
35
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-list.html
36
+ */
37
+ list(): import("../../../services/navvy").NavvySimple<iBXRestCrmTimelineIconListResult, iBXRestCrmTimelineIconListResult, undefined>;
38
+ /**
39
+ * Удаляет пользовательскую иконку. Системные иконки удалить нельзя.
40
+ *
41
+ * Метод доступен только администратору.
42
+ *
43
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-delete.html
44
+ */
45
+ delete(param: iBXRestParamCrmTimelineMediaGet): import("../../../services/navvy").NavvySimple<boolean | null, boolean | null, iBXRestParamCrmTimelineMediaGet | undefined>;
46
+ }
@@ -0,0 +1,35 @@
1
+ import { BXRestNavvyCrmTimelineBindings } from './bindings';
2
+ import { BXRestNavvyCrmTimelineComment } from './comment';
3
+ import { BXRestNavvyCrmTimelineIcon } from './icon';
4
+ import { BXRestNavvyCrmTimelineItem } from './item';
5
+ import { BXRestNavvyCrmTimelineLayout } from './layout';
6
+ import { BXRestNavvyCrmTimelineLogMessage } from './logmessage';
7
+ import { BXRestNavvyCrmTimelineLogo } from './logo';
8
+ import { BXRestNavvyCrmTimelineNote } from './note';
9
+ export * from './bindings';
10
+ export * from './comment';
11
+ export * from './icon';
12
+ export * from './item';
13
+ export * from './layout';
14
+ export * from './logmessage';
15
+ export * from './logo';
16
+ export * from './note';
17
+ /** Таймлайн CRM: комментарии, заметки, связи и лог-записи (`crm.timeline.*`). */
18
+ export declare class BXRestNavvyCrmTimeline {
19
+ /** Комментарии таймлайна. */
20
+ readonly comment: BXRestNavvyCrmTimelineComment;
21
+ /** Заметки к записям таймлайна и делам. */
22
+ readonly note: BXRestNavvyCrmTimelineNote;
23
+ /** Связи записей таймлайна с элементами CRM. */
24
+ readonly bindings: BXRestNavvyCrmTimelineBindings;
25
+ /** Дополнительные контентные блоки записей. */
26
+ readonly layout: BXRestNavvyCrmTimelineLayout;
27
+ /** Лог-записи приложения. */
28
+ readonly logMessage: BXRestNavvyCrmTimelineLogMessage;
29
+ /** Иконки лог-записей. */
30
+ readonly icon: BXRestNavvyCrmTimelineIcon;
31
+ /** Логотипы лог-записей. */
32
+ readonly logo: BXRestNavvyCrmTimelineLogo;
33
+ /** Закрепление и открепление записей. */
34
+ readonly item: BXRestNavvyCrmTimelineItem;
35
+ }
@@ -0,0 +1,23 @@
1
+ import { iBXRestParamCrmTimelineItemPin } from '../../../typification/rest/crm';
2
+ /** Действия над записями таймлайна (`crm.timeline.item.*`). */
3
+ export declare class BXRestNavvyCrmTimelineItem {
4
+ private readonly Navvy;
5
+ readonly url: {
6
+ /** Закрепляет запись в таймлайне элемента CRM. */
7
+ pin: string[];
8
+ /** Открепляет запись в таймлайне элемента CRM. */
9
+ unpin: string[];
10
+ };
11
+ /**
12
+ * Закрепляет запись в таймлайне указанного элемента CRM.
13
+ *
14
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/timeline-item/crm-timeline-item-pin.html
15
+ */
16
+ pin(param: iBXRestParamCrmTimelineItemPin): import("../../../services/navvy").NavvySimple<null, null, iBXRestParamCrmTimelineItemPin | undefined>;
17
+ /**
18
+ * Открепляет запись в таймлайне указанного элемента CRM.
19
+ *
20
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/timeline-item/crm-timeline-item-unpin.html
21
+ */
22
+ unpin(param: iBXRestParamCrmTimelineItemPin): import("../../../services/navvy").NavvySimple<null, null, iBXRestParamCrmTimelineItemPin | undefined>;
23
+ }
@@ -0,0 +1,35 @@
1
+ import { iBXRestCrmTimelineLayoutResult, iBXRestCrmTimelineSuccessResult, iBXRestParamCrmTimelineLayoutBlocks, iBXRestParamCrmTimelineLayoutBlocksSet } from '../../../../typification/rest/crm';
2
+ /** Дополнительные контентные блоки записи таймлайна (`crm.timeline.layout.blocks.*`). */
3
+ export declare class BXRestNavvyCrmTimelineLayoutBlocks {
4
+ private readonly Navvy;
5
+ readonly url: {
6
+ /** Устанавливает полный набор блоков текущего приложения. */
7
+ set: string[];
8
+ /** Возвращает набор блоков текущего приложения. */
9
+ get: string[];
10
+ /** Удаляет набор блоков текущего приложения. */
11
+ delete: string[];
12
+ };
13
+ /**
14
+ * Устанавливает набор дополнительных контентных блоков в запись таймлайна.
15
+ *
16
+ * Новый вызов полностью заменяет набор, ранее установленный тем же приложением.
17
+ * Метод доступен администратору и не применяется к делам, лог-записям и
18
+ * устаревшим типам записей таймлайна.
19
+ *
20
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/layout/blocks/crm-timeline-layout-blocks-set.html
21
+ */
22
+ set(param: iBXRestParamCrmTimelineLayoutBlocksSet): import("../../../../services/navvy").NavvySimple<iBXRestCrmTimelineSuccessResult | null, iBXRestCrmTimelineSuccessResult | null, iBXRestParamCrmTimelineLayoutBlocksSet | undefined>;
23
+ /**
24
+ * Возвращает набор дополнительных контентных блоков, установленный текущим приложением.
25
+ *
26
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/layout/blocks/crm-timeline-layout-blocks-get.html
27
+ */
28
+ get(param: iBXRestParamCrmTimelineLayoutBlocks): import("../../../../services/navvy").NavvySimple<iBXRestCrmTimelineLayoutResult, iBXRestCrmTimelineLayoutResult, iBXRestParamCrmTimelineLayoutBlocks | undefined>;
29
+ /**
30
+ * Удаляет набор дополнительных контентных блоков текущего приложения.
31
+ *
32
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/layout/blocks/crm-timeline-layout-blocks-delete.html
33
+ */
34
+ delete(param: iBXRestParamCrmTimelineLayoutBlocks): import("../../../../services/navvy").NavvySimple<iBXRestCrmTimelineSuccessResult | null, iBXRestCrmTimelineSuccessResult | null, iBXRestParamCrmTimelineLayoutBlocks | undefined>;
35
+ }
@@ -0,0 +1,7 @@
1
+ import { BXRestNavvyCrmTimelineLayoutBlocks } from './blocks';
2
+ export * from './blocks';
3
+ /** Визуальное расширение записей таймлайна (`crm.timeline.layout.*`). */
4
+ export declare class BXRestNavvyCrmTimelineLayout {
5
+ /** Дополнительные контентные блоки записи. */
6
+ readonly blocks: BXRestNavvyCrmTimelineLayoutBlocks;
7
+ }
@@ -0,0 +1,44 @@
1
+ import { iBXRestCrmTimelineLogMessage, iBXRestCrmTimelineLogMessageResult, iBXRestParamCrmTimelineLogMessageAdd, iBXRestParamCrmTimelineLogMessageGet, iBXRestParamCrmTimelineLogMessageList } from '../../../typification/rest/crm';
2
+ /** Лог-записи приложения в таймлайне (`crm.timeline.logmessage.*`). */
3
+ export declare class BXRestNavvyCrmTimelineLogMessage {
4
+ private readonly Navvy;
5
+ readonly url: {
6
+ /** Добавляет лог-запись приложения. */
7
+ add: string[];
8
+ /** Возвращает лог-запись по идентификатору. */
9
+ get: string[];
10
+ /** Возвращает лог-записи приложения для элемента CRM. */
11
+ list: string[];
12
+ /** Удаляет лог-запись приложения. */
13
+ delete: string[];
14
+ };
15
+ /**
16
+ * Добавляет новую лог-запись приложения в таймлайн элемента CRM.
17
+ *
18
+ * Значение `iconCode` должно присутствовать в результате `crm.timeline.icon.list`.
19
+ *
20
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-add.html
21
+ */
22
+ add(param: iBXRestParamCrmTimelineLogMessageAdd): import("../../../services/navvy").NavvySimple<iBXRestCrmTimelineLogMessageResult, iBXRestCrmTimelineLogMessageResult, iBXRestParamCrmTimelineLogMessageAdd | undefined>;
23
+ /**
24
+ * Возвращает лог-запись, ранее добавленную приложением.
25
+ *
26
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-get.html
27
+ */
28
+ get(param: iBXRestParamCrmTimelineLogMessageGet): import("../../../services/navvy").NavvySimple<iBXRestCrmTimelineLogMessageResult, iBXRestCrmTimelineLogMessageResult, iBXRestParamCrmTimelineLogMessageGet | undefined>;
29
+ /**
30
+ * Возвращает лог-записи приложения для указанного элемента CRM.
31
+ *
32
+ * Системные записи метод не возвращает. Размер страницы REST API фиксирован
33
+ * и равен 10 записям; `resAll()` учитывает этот размер.
34
+ *
35
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-list.html
36
+ */
37
+ list(param: iBXRestParamCrmTimelineLogMessageList): import("../../../services/navvy").NavvyPag<iBXRestCrmTimelineLogMessage, iBXRestCrmTimelineLogMessage, iBXRestParamCrmTimelineLogMessageList>;
38
+ /**
39
+ * Удаляет лог-запись, ранее добавленную приложением.
40
+ *
41
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-delete.html
42
+ */
43
+ delete(param: iBXRestParamCrmTimelineLogMessageGet): import("../../../services/navvy").NavvySimple<boolean | null, boolean | null, iBXRestParamCrmTimelineLogMessageGet | undefined>;
44
+ }
@@ -0,0 +1,46 @@
1
+ import { iBXRestCrmTimelineLogoListResult, iBXRestCrmTimelineLogoResult, iBXRestParamCrmTimelineMediaAdd, iBXRestParamCrmTimelineMediaGet } from '../../../typification/rest/crm';
2
+ /** Логотипы лог-записей (`crm.timeline.logo.*`). */
3
+ export declare class BXRestNavvyCrmTimelineLogo {
4
+ private readonly Navvy;
5
+ readonly url: {
6
+ /** Добавляет пользовательский логотип. */
7
+ add: string[];
8
+ /** Возвращает логотип по коду. */
9
+ get: string[];
10
+ /** Возвращает системные и пользовательские логотипы. */
11
+ list: string[];
12
+ /** Удаляет пользовательский логотип. */
13
+ delete: string[];
14
+ };
15
+ /**
16
+ * Добавляет пользовательский логотип лог-записи.
17
+ *
18
+ * Метод доступен только администратору. Передайте прозрачный PNG 60×60 пикселей
19
+ * в виде Base64-строки.
20
+ *
21
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-add.html
22
+ */
23
+ add(param: iBXRestParamCrmTimelineMediaAdd): import("../../../services/navvy").NavvySimple<iBXRestCrmTimelineLogoResult, iBXRestCrmTimelineLogoResult, iBXRestParamCrmTimelineMediaAdd | undefined>;
24
+ /**
25
+ * Возвращает системный или пользовательский логотип по коду.
26
+ *
27
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-get.html
28
+ */
29
+ get(param: iBXRestParamCrmTimelineMediaGet): import("../../../services/navvy").NavvySimple<iBXRestCrmTimelineLogoResult, iBXRestCrmTimelineLogoResult, iBXRestParamCrmTimelineMediaGet | undefined>;
30
+ /**
31
+ * Возвращает список всех доступных системных и пользовательских логотипов.
32
+ *
33
+ * Поле `isSystem` отличает встроенный логотип от добавленного приложением.
34
+ *
35
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-list.html
36
+ */
37
+ list(): import("../../../services/navvy").NavvySimple<iBXRestCrmTimelineLogoListResult, iBXRestCrmTimelineLogoListResult, undefined>;
38
+ /**
39
+ * Удаляет пользовательский логотип. Системные логотипы удалить нельзя.
40
+ *
41
+ * Метод доступен только администратору.
42
+ *
43
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-delete.html
44
+ */
45
+ delete(param: iBXRestParamCrmTimelineMediaGet): import("../../../services/navvy").NavvySimple<boolean | null, boolean | null, iBXRestParamCrmTimelineMediaGet | undefined>;
46
+ }
@@ -0,0 +1,33 @@
1
+ import { iBXRestCrmTimelineNote, iBXRestParamCrmTimelineNote, iBXRestParamCrmTimelineNoteSave } from '../../../typification/rest/crm';
2
+ /** Заметки к записям таймлайна и делам (`crm.timeline.note.*`). */
3
+ export declare class BXRestNavvyCrmTimelineNote {
4
+ private readonly Navvy;
5
+ readonly url: {
6
+ /** Возвращает заметку к записи таймлайна или делу. */
7
+ get: string[];
8
+ /** Создает или обновляет заметку. */
9
+ save: string[];
10
+ /** Удаляет заметку. */
11
+ delete: string[];
12
+ };
13
+ /**
14
+ * Возвращает заметку к записи истории таймлайна или делу CRM.
15
+ *
16
+ * В `itemType` передайте `1` для записи истории или `2` для дела.
17
+ *
18
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-get.html
19
+ */
20
+ get(param: iBXRestParamCrmTimelineNote): import("../../../services/navvy").NavvySimple<iBXRestCrmTimelineNote, iBXRestCrmTimelineNote, iBXRestParamCrmTimelineNote | undefined>;
21
+ /**
22
+ * Создает заметку или заменяет текст существующей.
23
+ *
24
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-save.html
25
+ */
26
+ save(param: iBXRestParamCrmTimelineNoteSave): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmTimelineNoteSave | undefined>;
27
+ /**
28
+ * Удаляет заметку у записи истории таймлайна или дела CRM.
29
+ *
30
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-delete.html
31
+ */
32
+ delete(param: iBXRestParamCrmTimelineNote): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmTimelineNote | undefined>;
33
+ }
@@ -15,7 +15,10 @@ import { BXRestNavvyCrmEntity } from './crm/entity';
15
15
  import { BXRestNavvyCrmCallList } from './crm/calllist/index';
16
16
  import { BXRestNavvyCrmAddress } from './crm/address';
17
17
  import { BXRestNavvyCrmRequisite } from './crm/requisite/index';
18
+ import { BXRestNavvyCrmTimeline } from './crm/timeline/index';
18
19
  export declare class BXRestNavvyCrm {
20
+ /** Таймлайн CRM: комментарии, заметки, связи и лог-записи (`crm.timeline.*`). */
21
+ readonly timeline: BXRestNavvyCrmTimeline;
19
22
  /** Адреса CRM, в том числе адреса реквизитов (`crm.address.*`). */
20
23
  readonly address: BXRestNavvyCrmAddress;
21
24
  /** Реквизиты, банковские данные, связи и шаблоны (`crm.requisite.*`). */
@@ -14,3 +14,4 @@ export * from './duplicate';
14
14
  export * from './entity';
15
15
  export * from './calllist';
16
16
  export * from './requisite';
17
+ export * from './timeline';
@@ -0,0 +1,33 @@
1
+ import { iBXRestCrmFieldDescription } from '../enum';
2
+ /** Связь записи таймлайна с элементом CRM. */
3
+ export interface iBXRestCrmTimelineBinding {
4
+ /** Идентификатор записи таймлайна. */
5
+ OWNER_ID: string;
6
+ /** Идентификатор связанного элемента CRM. */
7
+ ENTITY_ID: string;
8
+ /** Тип элемента CRM: `lead`, `deal`, `contact`, `company` или `order`. */
9
+ ENTITY_TYPE: string;
10
+ }
11
+ /** Поля для добавления или удаления связи записи таймлайна. */
12
+ export interface iBXRestCrmTimelineBindingFields {
13
+ /** Идентификатор записи таймлайна. */
14
+ OWNER_ID: number;
15
+ /** Идентификатор элемента CRM. */
16
+ ENTITY_ID: number;
17
+ /** Тип элемента CRM: `lead`, `deal`, `contact`, `company` или `order`. */
18
+ ENTITY_TYPE: string;
19
+ }
20
+ /** Параметры добавления или удаления связи записи таймлайна. */
21
+ export interface iBXRestParamCrmTimelineBindingChange {
22
+ /** Поля связи. */
23
+ fields: iBXRestCrmTimelineBindingFields;
24
+ }
25
+ /** Параметры получения связей записи таймлайна. */
26
+ export interface iBXRestParamCrmTimelineBindingList {
27
+ /** Фильтр с обязательным идентификатором записи таймлайна. */
28
+ filter: {
29
+ OWNER_ID: number;
30
+ };
31
+ }
32
+ /** Описание полей связи, возвращаемое `crm.timeline.bindings.fields`. */
33
+ export type iBXRestCrmTimelineBindingFieldsDescription = Record<keyof iBXRestCrmTimelineBinding, iBXRestCrmFieldDescription>;
@@ -0,0 +1,122 @@
1
+ import { iBXRestPagination } from '../../base/api-pagination-bx';
2
+ import { iBXRestCrmFieldDescription } from '../enum';
3
+ import { iBXRestCrmTimelineAttachedFile, iBXRestCrmTimelineSortOrder } from './common';
4
+ /** Изображение, если прикрепленный к комментарию файл является картинкой. */
5
+ export interface iBXRestCrmTimelineCommentFileImage {
6
+ /** Ширина изображения в пикселях. */
7
+ width: number;
8
+ /** Высота изображения в пикселях. */
9
+ height: number;
10
+ }
11
+ /** Файл, прикрепленный к комментарию таймлайна. */
12
+ export interface iBXRestCrmTimelineCommentFile {
13
+ /** Идентификатор файла. */
14
+ id: number;
15
+ /** Дата и время добавления в формате ISO 8601. */
16
+ date: string;
17
+ /** Тип файла, например `image`. */
18
+ type: string;
19
+ /** Имя файла. */
20
+ name: string;
21
+ /** Размер файла в байтах. */
22
+ size: number;
23
+ /** Размеры изображения; присутствуют только у изображений. */
24
+ image?: iBXRestCrmTimelineCommentFileImage;
25
+ /** Идентификатор автора файла. */
26
+ authorId: number;
27
+ /** Имя автора файла. */
28
+ authorName: string;
29
+ /** URL предварительного просмотра. */
30
+ urlPreview: string;
31
+ /** URL просмотра файла. */
32
+ urlShow: string;
33
+ /** URL скачивания файла. */
34
+ urlDownload: string;
35
+ }
36
+ /** Комментарий таймлайна в исходном формате REST API. */
37
+ export interface iBXRestCrmTimelineComment {
38
+ /** Идентификатор комментария. */
39
+ ID: string;
40
+ /** Идентификатор элемента CRM. */
41
+ ENTITY_ID: string;
42
+ /** Тип элемента CRM: `lead`, `deal`, `contact`, `company`, `order` или `dynamic_*`. */
43
+ ENTITY_TYPE: string;
44
+ /** Дата и время создания в формате ISO 8601. */
45
+ CREATED: string;
46
+ /** Текст комментария. */
47
+ COMMENT: string;
48
+ /** Идентификатор автора. */
49
+ AUTHOR_ID: string;
50
+ /** Прикрепленные файлы, индексированные их идентификаторами. */
51
+ FILES: Record<string, iBXRestCrmTimelineCommentFile>;
52
+ }
53
+ /** Поля нового комментария таймлайна. */
54
+ export interface iBXRestCrmTimelineCommentAddFields {
55
+ /** Идентификатор элемента CRM. */
56
+ ENTITY_ID: number;
57
+ /** Тип элемента CRM: `lead`, `deal`, `contact`, `company`, `order` или `dynamic_*`. */
58
+ ENTITY_TYPE: string;
59
+ /** Текст комментария. */
60
+ COMMENT: string;
61
+ /** Файлы в формате `[имя, содержимое Base64]`. */
62
+ FILES?: iBXRestCrmTimelineAttachedFile[];
63
+ }
64
+ /** Параметры `crm.timeline.comment.add`. */
65
+ export interface iBXRestParamCrmTimelineCommentAdd {
66
+ /**
67
+ * Поля комментария.
68
+ *
69
+ * Ключ должен называться именно `fields` в нижнем регистре.
70
+ */
71
+ fields: iBXRestCrmTimelineCommentAddFields;
72
+ }
73
+ /** Изменяемые поля комментария таймлайна. */
74
+ export interface iBXRestCrmTimelineCommentUpdateFields {
75
+ /** Новый текст комментария. */
76
+ COMMENT?: string;
77
+ /** Новый список файлов в формате `[имя, содержимое Base64]`. */
78
+ FILES?: iBXRestCrmTimelineAttachedFile[];
79
+ }
80
+ /** Параметры `crm.timeline.comment.update`. */
81
+ export interface iBXRestParamCrmTimelineCommentUpdate {
82
+ /** Идентификатор комментария. */
83
+ id: number;
84
+ /**
85
+ * Изменяемые поля.
86
+ *
87
+ * Ключ должен называться именно `fields` в нижнем регистре.
88
+ */
89
+ fields: iBXRestCrmTimelineCommentUpdateFields;
90
+ /** Тип связанного объекта CRM, например `2` для сделки. */
91
+ ownerTypeId?: number;
92
+ /** Идентификатор связанного элемента CRM. */
93
+ ownerId?: number;
94
+ }
95
+ /** Параметры получения комментария. */
96
+ export interface iBXRestParamCrmTimelineCommentGet {
97
+ /** Идентификатор комментария. */
98
+ id: number;
99
+ }
100
+ /** Параметры списка комментариев. */
101
+ export interface iBXRestParamCrmTimelineCommentList extends iBXRestPagination {
102
+ /** Возвращаемые поля. Если не указаны, возвращаются все поля. */
103
+ select?: (keyof iBXRestCrmTimelineComment)[];
104
+ /** Обязательная привязка комментариев к элементу CRM. */
105
+ filter: {
106
+ /** Идентификатор элемента CRM. */
107
+ ENTITY_ID: number;
108
+ /** Тип элемента CRM, например `deal`, `lead`, `contact` или `company`. */
109
+ ENTITY_TYPE: string;
110
+ };
111
+ /** Сортировка по `ID`, `CREATED` и/или `AUTHOR_ID`. */
112
+ order?: Partial<Record<'ID' | 'CREATED' | 'AUTHOR_ID', iBXRestCrmTimelineSortOrder>>;
113
+ }
114
+ /** Параметры удаления комментария. */
115
+ export interface iBXRestParamCrmTimelineCommentDelete extends iBXRestParamCrmTimelineCommentGet {
116
+ /** Тип связанного объекта CRM. Позволяет удалить только указанную привязку. */
117
+ ownerTypeId?: number;
118
+ /** Идентификатор связанного элемента CRM. Используется вместе с `ownerTypeId`. */
119
+ ownerId?: number;
120
+ }
121
+ /** Описание полей комментария, возвращаемое `crm.timeline.comment.fields`. */
122
+ export type iBXRestCrmTimelineCommentFields = Record<keyof iBXRestCrmTimelineComment, iBXRestCrmFieldDescription>;
@@ -0,0 +1,31 @@
1
+ /** Допустимое направление сортировки в методах таймлайна CRM. */
2
+ export type iBXRestCrmTimelineSortOrder = 'ASC' | 'DESC' | 'asc' | 'desc';
3
+ /**
4
+ * Файл для загрузки в комментарий таймлайна.
5
+ *
6
+ * Первый элемент — имя файла, второй — его содержимое в Base64.
7
+ */
8
+ export type iBXRestCrmTimelineAttachedFile = [fileName: string, base64Content: string];
9
+ /** Описание пользовательской иконки или логотипа лог-записи. */
10
+ export interface iBXRestCrmTimelineMedia {
11
+ /** Уникальный код ресурса. */
12
+ code: string;
13
+ /** `true` для встроенного ресурса Битрикс24, `false` для добавленного приложением. */
14
+ isSystem: boolean;
15
+ /** Путь к загруженному файлу; для системного ресурса обычно пустая строка. */
16
+ fileUri: string;
17
+ }
18
+ /** Параметр метода, принимающего код иконки или логотипа. */
19
+ export interface iBXRestParamCrmTimelineMediaGet {
20
+ /** Код ресурса. Список кодов возвращают методы `list`. */
21
+ code: string;
22
+ }
23
+ /** Параметры добавления пользовательской иконки или логотипа. */
24
+ export interface iBXRestParamCrmTimelineMediaAdd extends iBXRestParamCrmTimelineMediaGet {
25
+ /** Содержимое PNG-файла в Base64. */
26
+ fileContent: string;
27
+ }
28
+ /** Результат операции над дополнительными контентными блоками. */
29
+ export interface iBXRestCrmTimelineSuccessResult {
30
+ success: true;
31
+ }
@@ -0,0 +1,9 @@
1
+ import { iBXRestCrmTimelineMedia } from './common';
2
+ /** Результат добавления или получения иконки лог-записи. */
3
+ export interface iBXRestCrmTimelineIconResult {
4
+ icon: iBXRestCrmTimelineMedia;
5
+ }
6
+ /** Результат получения списка доступных иконок. */
7
+ export interface iBXRestCrmTimelineIconListResult {
8
+ icons: iBXRestCrmTimelineMedia[];
9
+ }
@@ -0,0 +1,9 @@
1
+ export * from './common';
2
+ export * from './comment';
3
+ export * from './note';
4
+ export * from './bindings';
5
+ export * from './layout';
6
+ export * from './logmessage';
7
+ export * from './icon';
8
+ export * from './logo';
9
+ export * from './item';
@@ -0,0 +1,9 @@
1
+ /** Параметры закрепления или открепления записи таймлайна. */
2
+ export interface iBXRestParamCrmTimelineItemPin {
3
+ /** Идентификатор записи таймлайна. */
4
+ id: number;
5
+ /** Идентификатор типа связанного объекта CRM, например `2` для сделки. */
6
+ ownerTypeId: number;
7
+ /** Идентификатор связанного элемента CRM. */
8
+ ownerId: number;
9
+ }