bx-rest 0.10.6 → 0.11.0

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 (94) 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/bizproc/activity.mjs +64 -0
  4. package/esm2022/request-navvy/bizproc/event.mjs +24 -0
  5. package/esm2022/request-navvy/bizproc/robot.mjs +51 -0
  6. package/esm2022/request-navvy/bizproc/task.mjs +25 -7
  7. package/esm2022/request-navvy/bizproc/workflow/template.mjs +54 -0
  8. package/esm2022/request-navvy/bizproc/workflow.mjs +31 -9
  9. package/esm2022/request-navvy/bizproc.mjs +13 -1
  10. package/esm2022/request-navvy/crm/timeline/bindings.mjs +51 -0
  11. package/esm2022/request-navvy/crm/timeline/comment.mjs +83 -0
  12. package/esm2022/request-navvy/crm/timeline/icon.mjs +58 -0
  13. package/esm2022/request-navvy/crm/timeline/index.mjs +38 -0
  14. package/esm2022/request-navvy/crm/timeline/item.mjs +31 -0
  15. package/esm2022/request-navvy/crm/timeline/layout/blocks.mjs +45 -0
  16. package/esm2022/request-navvy/crm/timeline/layout/index.mjs +10 -0
  17. package/esm2022/request-navvy/crm/timeline/logmessage.mjs +58 -0
  18. package/esm2022/request-navvy/crm/timeline/logo.mjs +58 -0
  19. package/esm2022/request-navvy/crm/timeline/note.mjs +43 -0
  20. package/esm2022/request-navvy/crm.mjs +4 -1
  21. package/esm2022/services/navvy/navvy-pag.mjs +2 -2
  22. package/esm2022/typification/rest/bizproc/activity.mjs +2 -0
  23. package/esm2022/typification/rest/bizproc/base/registration.mjs +2 -0
  24. package/esm2022/typification/rest/bizproc/event.mjs +2 -0
  25. package/esm2022/typification/rest/bizproc/robot.mjs +2 -0
  26. package/esm2022/typification/rest/bizproc/task/complete.mjs +1 -1
  27. package/esm2022/typification/rest/bizproc/task/delegate.mjs +1 -1
  28. package/esm2022/typification/rest/bizproc/workflow/kill.mjs +1 -1
  29. package/esm2022/typification/rest/bizproc/workflow/start.mjs +1 -1
  30. package/esm2022/typification/rest/bizproc/workflow/template/add.mjs +2 -0
  31. package/esm2022/typification/rest/bizproc/workflow/template/delete.mjs +2 -0
  32. package/esm2022/typification/rest/bizproc/workflow/template/list.mjs +1 -1
  33. package/esm2022/typification/rest/bizproc/workflow/template/update.mjs +2 -0
  34. package/esm2022/typification/rest/bizproc/workflow/terminate.mjs +1 -1
  35. package/esm2022/typification/rest/bizproc.mjs +8 -1
  36. package/esm2022/typification/rest/crm/index.mjs +2 -1
  37. package/esm2022/typification/rest/crm/timeline/bindings.mjs +2 -0
  38. package/esm2022/typification/rest/crm/timeline/comment.mjs +2 -0
  39. package/esm2022/typification/rest/crm/timeline/common.mjs +2 -0
  40. package/esm2022/typification/rest/crm/timeline/icon.mjs +2 -0
  41. package/esm2022/typification/rest/crm/timeline/index.mjs +10 -0
  42. package/esm2022/typification/rest/crm/timeline/item.mjs +2 -0
  43. package/esm2022/typification/rest/crm/timeline/layout.mjs +2 -0
  44. package/esm2022/typification/rest/crm/timeline/logmessage.mjs +2 -0
  45. package/esm2022/typification/rest/crm/timeline/logo.mjs +2 -0
  46. package/esm2022/typification/rest/crm/timeline/note.mjs +2 -0
  47. package/esm2022/typification/rest/user/user.mjs +1 -1
  48. package/fesm2022/bx-rest.mjs +717 -15
  49. package/fesm2022/bx-rest.mjs.map +1 -1
  50. package/package.json +1 -1
  51. package/request-navvy/bizproc/activity.d.ts +50 -0
  52. package/request-navvy/bizproc/event.d.ts +18 -0
  53. package/request-navvy/bizproc/robot.d.ts +39 -0
  54. package/request-navvy/bizproc/task.d.ts +21 -3
  55. package/request-navvy/bizproc/workflow/template.d.ts +42 -0
  56. package/request-navvy/bizproc/workflow.d.ts +26 -4
  57. package/request-navvy/bizproc.d.ts +12 -0
  58. package/request-navvy/crm/timeline/bindings.d.ts +39 -0
  59. package/request-navvy/crm/timeline/comment.d.ts +67 -0
  60. package/request-navvy/crm/timeline/icon.d.ts +46 -0
  61. package/request-navvy/crm/timeline/index.d.ts +35 -0
  62. package/request-navvy/crm/timeline/item.d.ts +23 -0
  63. package/request-navvy/crm/timeline/layout/blocks.d.ts +35 -0
  64. package/request-navvy/crm/timeline/layout/index.d.ts +7 -0
  65. package/request-navvy/crm/timeline/logmessage.d.ts +44 -0
  66. package/request-navvy/crm/timeline/logo.d.ts +46 -0
  67. package/request-navvy/crm/timeline/note.d.ts +33 -0
  68. package/request-navvy/crm.d.ts +3 -0
  69. package/typification/rest/bizproc/activity.d.ts +25 -0
  70. package/typification/rest/bizproc/base/registration.d.ts +66 -0
  71. package/typification/rest/bizproc/event.d.ts +9 -0
  72. package/typification/rest/bizproc/robot.d.ts +18 -0
  73. package/typification/rest/bizproc/task/complete.d.ts +6 -0
  74. package/typification/rest/bizproc/task/delegate.d.ts +4 -0
  75. package/typification/rest/bizproc/workflow/kill.d.ts +3 -1
  76. package/typification/rest/bizproc/workflow/start.d.ts +9 -1
  77. package/typification/rest/bizproc/workflow/template/add.d.ts +21 -0
  78. package/typification/rest/bizproc/workflow/template/delete.d.ts +5 -0
  79. package/typification/rest/bizproc/workflow/template/list.d.ts +32 -6
  80. package/typification/rest/bizproc/workflow/template/update.d.ts +19 -0
  81. package/typification/rest/bizproc/workflow/terminate.d.ts +3 -0
  82. package/typification/rest/bizproc.d.ts +7 -0
  83. package/typification/rest/crm/index.d.ts +1 -0
  84. package/typification/rest/crm/timeline/bindings.d.ts +33 -0
  85. package/typification/rest/crm/timeline/comment.d.ts +122 -0
  86. package/typification/rest/crm/timeline/common.d.ts +31 -0
  87. package/typification/rest/crm/timeline/icon.d.ts +9 -0
  88. package/typification/rest/crm/timeline/index.d.ts +9 -0
  89. package/typification/rest/crm/timeline/item.d.ts +9 -0
  90. package/typification/rest/crm/timeline/layout.d.ts +34 -0
  91. package/typification/rest/crm/timeline/logmessage.d.ts +52 -0
  92. package/typification/rest/crm/timeline/logo.d.ts +9 -0
  93. package/typification/rest/crm/timeline/note.d.ts +31 -0
  94. package/typification/rest/user/user.d.ts +32 -32
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bx-rest",
3
- "version": "0.10.6",
3
+ "version": "0.11.0",
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,50 @@
1
+ import { iBXRestParamBizprocActivityAdd, iBXRestParamBizprocActivityDelete, iBXRestParamBizprocActivityLog, iBXRestParamBizprocActivityUpdate } from '../../typification/rest/bizproc';
2
+ /** Действия бизнес-процессов приложения (`bizproc.activity.*`). */
3
+ export declare class BXRestNavvyBizProcActivity {
4
+ private readonly Navvy;
5
+ readonly url: {
6
+ /** Регистрирует новое действие. */
7
+ add: string[];
8
+ /** Обновляет зарегистрированное действие. */
9
+ update: string[];
10
+ /** Возвращает коды действий приложения. */
11
+ list: string[];
12
+ /** Записывает сообщение в журнал бизнес-процесса. */
13
+ log: string[];
14
+ /** Удаляет зарегистрированное действие. */
15
+ delete: string[];
16
+ };
17
+ /**
18
+ * Регистрирует новое действие бизнес-процесса для текущего приложения.
19
+ *
20
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-add.html
21
+ */
22
+ add(param: iBXRestParamBizprocActivityAdd): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamBizprocActivityAdd | undefined>;
23
+ /**
24
+ * Обновляет поля зарегистрированного действия.
25
+ *
26
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-update.html
27
+ */
28
+ update(param: iBXRestParamBizprocActivityUpdate): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamBizprocActivityUpdate | undefined>;
29
+ /**
30
+ * Возвращает список символьных кодов действий текущего приложения.
31
+ *
32
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-list.html
33
+ */
34
+ list(): import("../../services/navvy").NavvySimple<string[], string[], undefined>;
35
+ /**
36
+ * Записывает сообщение в журнал бизнес-процесса.
37
+ *
38
+ * Регистрация действия должна содержать `USE_SUBSCRIPTION: 'Y'`, а токен
39
+ * события должен оставаться актуальным.
40
+ *
41
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-log.html
42
+ */
43
+ log(param: iBXRestParamBizprocActivityLog): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamBizprocActivityLog | undefined>;
44
+ /**
45
+ * Удаляет действие, зарегистрированное текущим приложением.
46
+ *
47
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-delete.html
48
+ */
49
+ delete(param: iBXRestParamBizprocActivityDelete): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamBizprocActivityDelete | undefined>;
50
+ }
@@ -0,0 +1,18 @@
1
+ import { iBXRestParamBizprocEventSend } from '../../typification/rest/bizproc';
2
+ /** События действий и роботов (`bizproc.event.*`). */
3
+ export declare class BXRestNavvyBizProcEvent {
4
+ private readonly Navvy;
5
+ readonly url: {
6
+ /** Возвращает выходные значения действию или роботу. */
7
+ send: string[];
8
+ };
9
+ /**
10
+ * Возвращает выходные значения действию или роботу и завершает ожидание.
11
+ *
12
+ * Регистрация должна содержать `USE_SUBSCRIPTION: 'Y'`, а переданный
13
+ * `EVENT_TOKEN` должен оставаться актуальным.
14
+ *
15
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-event-send.html
16
+ */
17
+ send(param: iBXRestParamBizprocEventSend): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamBizprocEventSend | undefined>;
18
+ }
@@ -0,0 +1,39 @@
1
+ import { iBXRestParamBizprocRobotAdd, iBXRestParamBizprocRobotDelete, iBXRestParamBizprocRobotUpdate } from '../../typification/rest/bizproc';
2
+ /** Роботы приложения (`bizproc.robot.*`). */
3
+ export declare class BXRestNavvyBizProcRobot {
4
+ private readonly Navvy;
5
+ readonly url: {
6
+ /** Регистрирует нового робота. */
7
+ add: string[];
8
+ /** Обновляет зарегистрированного робота. */
9
+ update: string[];
10
+ /** Возвращает коды роботов приложения. */
11
+ list: string[];
12
+ /** Удаляет зарегистрированного робота. */
13
+ delete: string[];
14
+ };
15
+ /**
16
+ * Регистрирует нового робота для текущего приложения.
17
+ *
18
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-add.html
19
+ */
20
+ add(param: iBXRestParamBizprocRobotAdd): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamBizprocRobotAdd | undefined>;
21
+ /**
22
+ * Обновляет поля зарегистрированного робота.
23
+ *
24
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-update.html
25
+ */
26
+ update(param: iBXRestParamBizprocRobotUpdate): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamBizprocRobotUpdate | undefined>;
27
+ /**
28
+ * Возвращает список символьных кодов роботов текущего приложения.
29
+ *
30
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-list.html
31
+ */
32
+ list(): import("../../services/navvy").NavvySimple<string[], string[], undefined>;
33
+ /**
34
+ * Удаляет робота, зарегистрированного текущим приложением.
35
+ *
36
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-delete.html
37
+ */
38
+ delete(param: iBXRestParamBizprocRobotDelete): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamBizprocRobotDelete | undefined>;
39
+ }
@@ -1,16 +1,34 @@
1
1
  import { iBXRestBizprocTask, iBXRestParamBizprocTaskComplete, iBXRestParamBizprocTaskDelegate, iBXRestParamBizprocTaskList } from '../../typification/rest/bizproc';
2
+ /** Задания бизнес-процессов (`bizproc.task.*`). */
2
3
  export declare class BXRestNavvyBizProcTask {
3
4
  private readonly Navvy;
5
+ readonly url: {
6
+ /** Возвращает задания бизнес-процессов. */
7
+ list: string[];
8
+ /** Выполняет задание. */
9
+ complete: string[];
10
+ /** Делегирует задания другому пользователю. */
11
+ delegate: string[];
12
+ };
4
13
  /**
5
- * Возвращает список заданий бизнес-процессов
14
+ * Возвращает список заданий бизнес-процессов.
15
+ *
16
+ * Если `USER_ID` не задан, обычный пользователь получает только свои
17
+ * задания; руководитель и администратор могут запрашивать задания других.
18
+ *
19
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-task/bizproc-task-list.html
6
20
  */
7
21
  list(param?: iBXRestParamBizprocTaskList): import("../../services/navvy").NavvyPag<iBXRestBizprocTask, iBXRestBizprocTask, iBXRestParamBizprocTaskList>;
8
22
  /**
9
- * Выполняет задание бизнес-процесса
23
+ * Выполняет доступное текущему пользователю задание бизнес-процесса.
24
+ *
25
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-task/bizproc-task-complete.html
10
26
  */
11
27
  complete(param: iBXRestParamBizprocTaskComplete): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamBizprocTaskComplete | undefined>;
12
28
  /**
13
- * Делегирует задания бизнес-процесса другому пользователю
29
+ * Делегирует задания бизнес-процесса другому пользователю.
30
+ *
31
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-task/bizproc-task-delegate.html
14
32
  */
15
33
  delegate(param: iBXRestParamBizprocTaskDelegate): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamBizprocTaskDelegate | undefined>;
16
34
  }
@@ -0,0 +1,42 @@
1
+ import { iBXRestBizprocWorkflowTemplate, iBXRestParamBizprocWorkflowTemplateAdd, iBXRestParamBizprocWorkflowTemplateDelete, iBXRestParamBizprocWorkflowTemplateList, iBXRestParamBizprocWorkflowTemplateUpdate } from '../../../typification/rest/bizproc';
2
+ /** Шаблоны бизнес-процессов (`bizproc.workflow.template.*`). */
3
+ export declare class BXRestNavvyBizProcWorkflowTemplate {
4
+ private readonly Navvy;
5
+ readonly url: {
6
+ /** Добавляет шаблон из файла `.bpt`. */
7
+ add: string[];
8
+ /** Обновляет шаблон, созданный текущим приложением. */
9
+ update: string[];
10
+ /** Удаляет шаблон, созданный текущим приложением. */
11
+ delete: string[];
12
+ /** Возвращает список шаблонов. */
13
+ list: string[];
14
+ };
15
+ /**
16
+ * Добавляет шаблон бизнес-процесса из файла `.bpt`.
17
+ *
18
+ * Метод работает только в контексте приложения и привязывает новый шаблон
19
+ * к вызвавшему его приложению.
20
+ *
21
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-add.html
22
+ */
23
+ add(param: iBXRestParamBizprocWorkflowTemplateAdd): import("../../../services/navvy").NavvySimple<number, number, iBXRestParamBizprocWorkflowTemplateAdd | undefined>;
24
+ /**
25
+ * Обновляет шаблон, ранее созданный текущим приложением.
26
+ *
27
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-update.html
28
+ */
29
+ update(param: iBXRestParamBizprocWorkflowTemplateUpdate): import("../../../services/navvy").NavvySimple<number, number, iBXRestParamBizprocWorkflowTemplateUpdate | undefined>;
30
+ /**
31
+ * Удаляет шаблон, ранее созданный текущим приложением.
32
+ *
33
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-delete.html
34
+ */
35
+ delete(param: iBXRestParamBizprocWorkflowTemplateDelete): import("../../../services/navvy").NavvySimple<null, null, iBXRestParamBizprocWorkflowTemplateDelete | undefined>;
36
+ /**
37
+ * Возвращает список шаблонов с выборкой полей, фильтрацией и сортировкой.
38
+ *
39
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-list.html
40
+ */
41
+ list(param?: iBXRestParamBizprocWorkflowTemplateList): import("../../../services/navvy").NavvyPag<iBXRestBizprocWorkflowTemplate, iBXRestBizprocWorkflowTemplate, iBXRestParamBizprocWorkflowTemplateList>;
42
+ }
@@ -1,20 +1,42 @@
1
1
  import { iBXRestBizprocWorkflowInstance, iBXRestParamBizprocWorkflowInstances, iBXRestParamBizprocWorkflowKill, iBXRestParamBizprocWorkflowStart, iBXRestParamBizprocWorkflowTerminate } from '../../typification/rest/bizproc';
2
+ import { BXRestNavvyBizProcWorkflowTemplate } from './workflow/template';
3
+ /** Запущенные бизнес-процессы (`bizproc.workflow.*`). */
2
4
  export declare class BXRestNavvyBXRestBizProcWorkflow {
3
5
  private readonly Navvy;
6
+ /** Операции с шаблонами бизнес-процессов. */
7
+ readonly template: BXRestNavvyBizProcWorkflowTemplate;
8
+ readonly url: {
9
+ /** Запускает бизнес-процесс. */
10
+ start: string[];
11
+ /** Возвращает запущенные бизнес-процессы. */
12
+ instances: string[];
13
+ /** Останавливает процесс с сохранением данных. */
14
+ terminate: string[];
15
+ /** Удаляет процесс вместе с его данными. */
16
+ kill: string[];
17
+ };
4
18
  /**
5
- * Запускает Бизнес-процесс
19
+ * Запускает новый бизнес-процесс по шаблону для указанного документа.
20
+ *
21
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-start.html
6
22
  */
7
23
  start(param: iBXRestParamBizprocWorkflowStart): import("../../services/navvy").NavvySimple<string, string, iBXRestParamBizprocWorkflowStart | undefined>;
8
24
  /**
9
- * Возвращает список запущенных бизнес-процессов
25
+ * Возвращает список запущенных бизнес-процессов.
26
+ *
27
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-instances.html
10
28
  */
11
29
  instances(param?: iBXRestParamBizprocWorkflowInstances): import("../../services/navvy").NavvyPag<iBXRestBizprocWorkflowInstance, iBXRestBizprocWorkflowInstance, iBXRestParamBizprocWorkflowInstances>;
12
30
  /**
13
- * Останавливает активный бизнес-процесс с сохранением его данных
31
+ * Прерывает активный бизнес-процесс с сохранением его данных.
32
+ *
33
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-terminate.html
14
34
  */
15
35
  terminate(param: iBXRestParamBizprocWorkflowTerminate): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamBizprocWorkflowTerminate | undefined>;
16
36
  /**
17
- * Удаляет запущенный бизнес-процесс вместе со всеми его данными
37
+ * Удаляет запущенный бизнес-процесс вместе со всеми его данными.
38
+ *
39
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-kill.html
18
40
  */
19
41
  kill(param: iBXRestParamBizprocWorkflowKill): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamBizprocWorkflowKill | undefined>;
20
42
  }
@@ -1,9 +1,21 @@
1
1
  import { Observable } from 'rxjs';
2
2
  import { BXRestNavvyBizProcTask } from './bizproc/task';
3
3
  import { BXRestNavvyBXRestBizProcWorkflow } from './bizproc/workflow';
4
+ import { BXRestNavvyBizProcActivity } from './bizproc/activity';
5
+ import { BXRestNavvyBizProcEvent } from './bizproc/event';
6
+ import { BXRestNavvyBizProcRobot } from './bizproc/robot';
7
+ /** Бизнес-процессы, задания, действия и роботы (`bizproc.*`). */
4
8
  export declare class BXRestNavvyBizProc {
9
+ /** Задания бизнес-процессов. */
5
10
  readonly task: BXRestNavvyBizProcTask;
11
+ /** Запущенные бизнес-процессы и их шаблоны. */
6
12
  readonly workflow: BXRestNavvyBXRestBizProcWorkflow;
13
+ /** Действия бизнес-процессов, зарегистрированные приложением. */
14
+ readonly activity: BXRestNavvyBizProcActivity;
15
+ /** Роботы, зарегистрированные приложением. */
16
+ readonly robot: BXRestNavvyBizProcRobot;
17
+ /** Возврат результатов действиям и роботам. */
18
+ readonly event: BXRestNavvyBizProcEvent;
7
19
  private readonly BXRestNavvyLists;
8
20
  /**
9
21
  * Метод по запуску бизнес процессов из ленты
@@ -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
+ }