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
@@ -1056,6 +1056,19 @@ const $numerator = 'numerator';
1056
1056
  const $document = 'document';
1057
1057
  const $enablepublicurl = 'enablepublicurl';
1058
1058
  const $upload = 'upload';
1059
+ const $timeline = 'timeline';
1060
+ const $comment = 'comment';
1061
+ const $note = 'note';
1062
+ const $bindings = 'bindings';
1063
+ const $bind = 'bind';
1064
+ const $unbind = 'unbind';
1065
+ const $layout = 'layout';
1066
+ const $blocks = 'blocks';
1067
+ const $logmessage = 'logmessage';
1068
+ const $icon = 'icon';
1069
+ const $logo = 'logo';
1070
+ const $save = 'save';
1071
+ const $unpin = 'unpin';
1059
1072
 
1060
1073
  var partNameMethods$1 = /*#__PURE__*/Object.freeze({
1061
1074
  __proto__: null,
@@ -1073,7 +1086,10 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
1073
1086
  $automation: $automation,
1074
1087
  $availabletoadd: $availabletoadd,
1075
1088
  $bankdetail: $bankdetail,
1089
+ $bind: $bind,
1090
+ $bindings: $bindings,
1076
1091
  $bizproc: $bizproc,
1092
+ $blocks: $blocks,
1077
1093
  $blogcomment: $blogcomment,
1078
1094
  $blogpost: $blogpost,
1079
1095
  $booking: $booking,
@@ -1081,6 +1097,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
1081
1097
  $calllist: $calllist,
1082
1098
  $channel: $channel,
1083
1099
  $chat: $chat,
1100
+ $comment: $comment,
1084
1101
  $commentitem: $commentitem,
1085
1102
  $company: $company,
1086
1103
  $complete: $complete,
@@ -1128,6 +1145,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
1128
1145
  $hide: $hide,
1129
1146
  $history: $history,
1130
1147
  $iblock: $iblock,
1148
+ $icon: $icon,
1131
1149
  $id: $id,
1132
1150
  $idle: $idle,
1133
1151
  $im: $im,
@@ -1136,12 +1154,15 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
1136
1154
  $item: $item,
1137
1155
  $items: $items,
1138
1156
  $kill: $kill,
1157
+ $layout: $layout,
1139
1158
  $lead: $lead,
1140
1159
  $leave: $leave,
1141
1160
  $link: $link,
1142
1161
  $list: $list,
1143
1162
  $lists: $lists,
1144
1163
  $log: $log,
1164
+ $logmessage: $logmessage,
1165
+ $logo: $logo,
1145
1166
  $markdeleted: $markdeleted,
1146
1167
  $meeting: $meeting,
1147
1168
  $mergeBatch: $mergeBatch,
@@ -1151,6 +1172,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
1151
1172
  $multifield: $multifield,
1152
1173
  $mute: $mute,
1153
1174
  $nearest: $nearest,
1175
+ $note: $note,
1154
1176
  $numerator: $numerator,
1155
1177
  $params: $params,
1156
1178
  $pause: $pause,
@@ -1172,6 +1194,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
1172
1194
  $restore: $restore,
1173
1195
  $result: $result,
1174
1196
  $robot: $robot,
1197
+ $save: $save,
1175
1198
  $search: $search,
1176
1199
  $section: $section,
1177
1200
  $send: $send,
@@ -1193,8 +1216,11 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
1193
1216
  $terminate: $terminate,
1194
1217
  $time: $time,
1195
1218
  $timeMan: $timeMan,
1219
+ $timeline: $timeline,
1196
1220
  $trigger: $trigger,
1197
1221
  $type: $type,
1222
+ $unbind: $unbind,
1223
+ $unpin: $unpin,
1198
1224
  $unread: $unread,
1199
1225
  $unregister: $unregister,
1200
1226
  $update: $update,
@@ -2284,7 +2310,7 @@ class NavvyPag extends NavvyPagBase {
2284
2310
  if (items && instanceOfiBXRestAnswerSuccess(items)) {
2285
2311
  this.save = [];
2286
2312
  // TODO: проверить будет ли быстрее работать метод в случаях когда total < 100 (то есть можно обойтись двумя прямыми запросами)
2287
- if (items.total && items.total > 50) {
2313
+ if (items.total && items.total > this.pageSize) {
2288
2314
  const mathFloor = Math.floor(items.total / this.pageSize);
2289
2315
  const count = (mathFloor === items.total / this.pageSize) // если mathFloor равен обычному делению, значит один запрос будет лишним, так как результат первой страницы уже есть, а последняя в данном случаи будет пустая (или с мусорными аднными)
2290
2316
  ? [...Array(mathFloor - 1).keys()]
@@ -4558,64 +4584,297 @@ class BXRestNavvyDisk {
4558
4584
  }
4559
4585
  }
4560
4586
 
4587
+ /** Задания бизнес-процессов (`bizproc.task.*`). */
4561
4588
  class BXRestNavvyBizProcTask {
4562
4589
  constructor() {
4563
4590
  this.Navvy = new Navvy();
4591
+ this.url = {
4592
+ /** Возвращает задания бизнес-процессов. */
4593
+ list: [$bizproc, $task, $list],
4594
+ /** Выполняет задание. */
4595
+ complete: [$bizproc, $task, $complete],
4596
+ /** Делегирует задания другому пользователю. */
4597
+ delegate: [$bizproc, $task, $delegate]
4598
+ };
4564
4599
  }
4565
4600
  /**
4566
- * Возвращает список заданий бизнес-процессов
4601
+ * Возвращает список заданий бизнес-процессов.
4602
+ *
4603
+ * Если `USER_ID` не задан, обычный пользователь получает только свои
4604
+ * задания; руководитель и администратор могут запрашивать задания других.
4605
+ *
4606
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-task/bizproc-task-list.html
4567
4607
  */
4568
4608
  list(param = {}) {
4569
- return this.Navvy.pagNav([$bizproc, $task, $list], param);
4609
+ return this.Navvy.pagNav(this.url.list, param);
4570
4610
  }
4571
4611
  /**
4572
- * Выполняет задание бизнес-процесса
4612
+ * Выполняет доступное текущему пользователю задание бизнес-процесса.
4613
+ *
4614
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-task/bizproc-task-complete.html
4573
4615
  */
4574
4616
  complete(param) {
4575
- return this.Navvy.simple([$bizproc, $task, $complete], param);
4617
+ return this.Navvy.simple(this.url.complete, param);
4576
4618
  }
4577
4619
  /**
4578
- * Делегирует задания бизнес-процесса другому пользователю
4620
+ * Делегирует задания бизнес-процесса другому пользователю.
4621
+ *
4622
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-task/bizproc-task-delegate.html
4579
4623
  */
4580
4624
  delegate(param) {
4581
- return this.Navvy.simple([$bizproc, $task, $delegate], param);
4625
+ return this.Navvy.simple(this.url.delegate, param);
4582
4626
  }
4583
4627
  }
4584
4628
 
4629
+ /** Шаблоны бизнес-процессов (`bizproc.workflow.template.*`). */
4630
+ class BXRestNavvyBizProcWorkflowTemplate {
4631
+ constructor() {
4632
+ this.Navvy = new Navvy();
4633
+ this.url = {
4634
+ /** Добавляет шаблон из файла `.bpt`. */
4635
+ add: [$bizproc, $workflow, $template, $add],
4636
+ /** Обновляет шаблон, созданный текущим приложением. */
4637
+ update: [$bizproc, $workflow, $template, $update],
4638
+ /** Удаляет шаблон, созданный текущим приложением. */
4639
+ delete: [$bizproc, $workflow, $template, $delete],
4640
+ /** Возвращает список шаблонов. */
4641
+ list: [$bizproc, $workflow, $template, $list]
4642
+ };
4643
+ }
4644
+ /**
4645
+ * Добавляет шаблон бизнес-процесса из файла `.bpt`.
4646
+ *
4647
+ * Метод работает только в контексте приложения и привязывает новый шаблон
4648
+ * к вызвавшему его приложению.
4649
+ *
4650
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-add.html
4651
+ */
4652
+ add(param) {
4653
+ return this.Navvy.simple(this.url.add, param);
4654
+ }
4655
+ /**
4656
+ * Обновляет шаблон, ранее созданный текущим приложением.
4657
+ *
4658
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-update.html
4659
+ */
4660
+ update(param) {
4661
+ return this.Navvy.simple(this.url.update, param);
4662
+ }
4663
+ /**
4664
+ * Удаляет шаблон, ранее созданный текущим приложением.
4665
+ *
4666
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-delete.html
4667
+ */
4668
+ delete(param) {
4669
+ return this.Navvy.simple(this.url.delete, param);
4670
+ }
4671
+ /**
4672
+ * Возвращает список шаблонов с выборкой полей, фильтрацией и сортировкой.
4673
+ *
4674
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/template/bizproc-workflow-template-list.html
4675
+ */
4676
+ list(param = {}) {
4677
+ return this.Navvy.pagNav(this.url.list, param);
4678
+ }
4679
+ }
4680
+
4681
+ /** Запущенные бизнес-процессы (`bizproc.workflow.*`). */
4585
4682
  class BXRestNavvyBXRestBizProcWorkflow {
4586
4683
  constructor() {
4587
4684
  this.Navvy = new Navvy();
4685
+ /** Операции с шаблонами бизнес-процессов. */
4686
+ this.template = new BXRestNavvyBizProcWorkflowTemplate();
4687
+ this.url = {
4688
+ /** Запускает бизнес-процесс. */
4689
+ start: [$bizproc, $workflow, $start],
4690
+ /** Возвращает запущенные бизнес-процессы. */
4691
+ instances: [$bizproc, $workflow, $instances],
4692
+ /** Останавливает процесс с сохранением данных. */
4693
+ terminate: [$bizproc, $workflow, $terminate],
4694
+ /** Удаляет процесс вместе с его данными. */
4695
+ kill: [$bizproc, $workflow, $kill]
4696
+ };
4588
4697
  }
4589
4698
  /**
4590
- * Запускает Бизнес-процесс
4699
+ * Запускает новый бизнес-процесс по шаблону для указанного документа.
4700
+ *
4701
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-start.html
4591
4702
  */
4592
4703
  start(param) {
4593
- return this.Navvy.simple([$bizproc, $workflow, $start], param);
4704
+ return this.Navvy.simple(this.url.start, param);
4594
4705
  }
4595
4706
  /**
4596
- * Возвращает список запущенных бизнес-процессов
4707
+ * Возвращает список запущенных бизнес-процессов.
4708
+ *
4709
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-instances.html
4597
4710
  */
4598
4711
  instances(param = {}) {
4599
- return this.Navvy.pagNav([$bizproc, $workflow, $instances], param);
4712
+ return this.Navvy.pagNav(this.url.instances, param);
4600
4713
  }
4601
4714
  /**
4602
- * Останавливает активный бизнес-процесс с сохранением его данных
4715
+ * Прерывает активный бизнес-процесс с сохранением его данных.
4716
+ *
4717
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-terminate.html
4603
4718
  */
4604
4719
  terminate(param) {
4605
- return this.Navvy.simple([$bizproc, $workflow, $terminate], param);
4720
+ return this.Navvy.simple(this.url.terminate, param);
4606
4721
  }
4607
4722
  /**
4608
- * Удаляет запущенный бизнес-процесс вместе со всеми его данными
4723
+ * Удаляет запущенный бизнес-процесс вместе со всеми его данными.
4724
+ *
4725
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-workflow-kill.html
4609
4726
  */
4610
4727
  kill(param) {
4611
- return this.Navvy.simple([$bizproc, $workflow, $kill], param);
4728
+ return this.Navvy.simple(this.url.kill, param);
4729
+ }
4730
+ }
4731
+
4732
+ /** Действия бизнес-процессов приложения (`bizproc.activity.*`). */
4733
+ class BXRestNavvyBizProcActivity {
4734
+ constructor() {
4735
+ this.Navvy = new Navvy();
4736
+ this.url = {
4737
+ /** Регистрирует новое действие. */
4738
+ add: [$bizproc, $activity, $add],
4739
+ /** Обновляет зарегистрированное действие. */
4740
+ update: [$bizproc, $activity, $update],
4741
+ /** Возвращает коды действий приложения. */
4742
+ list: [$bizproc, $activity, $list],
4743
+ /** Записывает сообщение в журнал бизнес-процесса. */
4744
+ log: [$bizproc, $activity, $log],
4745
+ /** Удаляет зарегистрированное действие. */
4746
+ delete: [$bizproc, $activity, $delete]
4747
+ };
4748
+ }
4749
+ /**
4750
+ * Регистрирует новое действие бизнес-процесса для текущего приложения.
4751
+ *
4752
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-add.html
4753
+ */
4754
+ add(param) {
4755
+ return this.Navvy.simple(this.url.add, param);
4756
+ }
4757
+ /**
4758
+ * Обновляет поля зарегистрированного действия.
4759
+ *
4760
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-update.html
4761
+ */
4762
+ update(param) {
4763
+ return this.Navvy.simple(this.url.update, param);
4764
+ }
4765
+ /**
4766
+ * Возвращает список символьных кодов действий текущего приложения.
4767
+ *
4768
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-list.html
4769
+ */
4770
+ list() {
4771
+ return this.Navvy.simple(this.url.list);
4772
+ }
4773
+ /**
4774
+ * Записывает сообщение в журнал бизнес-процесса.
4775
+ *
4776
+ * Регистрация действия должна содержать `USE_SUBSCRIPTION: 'Y'`, а токен
4777
+ * события должен оставаться актуальным.
4778
+ *
4779
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-log.html
4780
+ */
4781
+ log(param) {
4782
+ return this.Navvy.simple(this.url.log, param);
4783
+ }
4784
+ /**
4785
+ * Удаляет действие, зарегистрированное текущим приложением.
4786
+ *
4787
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-activity/bizproc-activity-delete.html
4788
+ */
4789
+ delete(param) {
4790
+ return this.Navvy.simple(this.url.delete, param);
4791
+ }
4792
+ }
4793
+
4794
+ /** События действий и роботов (`bizproc.event.*`). */
4795
+ class BXRestNavvyBizProcEvent {
4796
+ constructor() {
4797
+ this.Navvy = new Navvy();
4798
+ this.url = {
4799
+ /** Возвращает выходные значения действию или роботу. */
4800
+ send: [$bizproc, $event, $send]
4801
+ };
4802
+ }
4803
+ /**
4804
+ * Возвращает выходные значения действию или роботу и завершает ожидание.
4805
+ *
4806
+ * Регистрация должна содержать `USE_SUBSCRIPTION: 'Y'`, а переданный
4807
+ * `EVENT_TOKEN` должен оставаться актуальным.
4808
+ *
4809
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-event-send.html
4810
+ */
4811
+ send(param) {
4812
+ return this.Navvy.simple(this.url.send, param);
4612
4813
  }
4613
4814
  }
4614
4815
 
4816
+ /** Роботы приложения (`bizproc.robot.*`). */
4817
+ class BXRestNavvyBizProcRobot {
4818
+ constructor() {
4819
+ this.Navvy = new Navvy();
4820
+ this.url = {
4821
+ /** Регистрирует нового робота. */
4822
+ add: [$bizproc, $robot, $add],
4823
+ /** Обновляет зарегистрированного робота. */
4824
+ update: [$bizproc, $robot, $update],
4825
+ /** Возвращает коды роботов приложения. */
4826
+ list: [$bizproc, $robot, $list],
4827
+ /** Удаляет зарегистрированного робота. */
4828
+ delete: [$bizproc, $robot, $delete]
4829
+ };
4830
+ }
4831
+ /**
4832
+ * Регистрирует нового робота для текущего приложения.
4833
+ *
4834
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-add.html
4835
+ */
4836
+ add(param) {
4837
+ return this.Navvy.simple(this.url.add, param);
4838
+ }
4839
+ /**
4840
+ * Обновляет поля зарегистрированного робота.
4841
+ *
4842
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-update.html
4843
+ */
4844
+ update(param) {
4845
+ return this.Navvy.simple(this.url.update, param);
4846
+ }
4847
+ /**
4848
+ * Возвращает список символьных кодов роботов текущего приложения.
4849
+ *
4850
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-list.html
4851
+ */
4852
+ list() {
4853
+ return this.Navvy.simple(this.url.list);
4854
+ }
4855
+ /**
4856
+ * Удаляет робота, зарегистрированного текущим приложением.
4857
+ *
4858
+ * @see https://apidocs.bitrix24.ru/api-reference/bizproc/bizproc-robot/bizproc-robot-delete.html
4859
+ */
4860
+ delete(param) {
4861
+ return this.Navvy.simple(this.url.delete, param);
4862
+ }
4863
+ }
4864
+
4865
+ /** Бизнес-процессы, задания, действия и роботы (`bizproc.*`). */
4615
4866
  class BXRestNavvyBizProc {
4616
4867
  constructor() {
4868
+ /** Задания бизнес-процессов. */
4617
4869
  this.task = new BXRestNavvyBizProcTask();
4870
+ /** Запущенные бизнес-процессы и их шаблоны. */
4618
4871
  this.workflow = new BXRestNavvyBXRestBizProcWorkflow();
4872
+ /** Действия бизнес-процессов, зарегистрированные приложением. */
4873
+ this.activity = new BXRestNavvyBizProcActivity();
4874
+ /** Роботы, зарегистрированные приложением. */
4875
+ this.robot = new BXRestNavvyBizProcRobot();
4876
+ /** Возврат результатов действиям и роботам. */
4877
+ this.event = new BXRestNavvyBizProcEvent();
4619
4878
  this.BXRestNavvyLists = new BXRestNavvyLists();
4620
4879
  }
4621
4880
  /**
@@ -8168,8 +8427,451 @@ class BXRestNavvyCrmRequisite {
8168
8427
  }
8169
8428
  }
8170
8429
 
8430
+ /** Связи записей таймлайна с элементами CRM (`crm.timeline.bindings.*`). */
8431
+ class BXRestNavvyCrmTimelineBindings {
8432
+ constructor() {
8433
+ this.Navvy = new Navvy();
8434
+ this.url = {
8435
+ /** Добавляет связь записи таймлайна с элементом CRM. */
8436
+ bind: [$crm, $timeline, $bindings, $bind],
8437
+ /** Возвращает все связи записи таймлайна. */
8438
+ list: [$crm, $timeline, $bindings, $list],
8439
+ /** Удаляет связь записи таймлайна с элементом CRM. */
8440
+ unbind: [$crm, $timeline, $bindings, $unbind],
8441
+ /** Возвращает описание полей связи. */
8442
+ fields: [$crm, $timeline, $bindings, 'fields']
8443
+ };
8444
+ }
8445
+ /**
8446
+ * Добавляет связь записи таймлайна с элементом CRM.
8447
+ *
8448
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-bind.html
8449
+ */
8450
+ bind(param) {
8451
+ return this.Navvy.simple(this.url.bind, param);
8452
+ }
8453
+ /**
8454
+ * Возвращает все связи записи таймлайна по обязательному `OWNER_ID`.
8455
+ *
8456
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-list.html
8457
+ */
8458
+ list(param) {
8459
+ return this.Navvy.simple(this.url.list, param);
8460
+ }
8461
+ /**
8462
+ * Удаляет связь записи таймлайна с указанным элементом CRM.
8463
+ *
8464
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-unbind.html
8465
+ */
8466
+ unbind(param) {
8467
+ return this.Navvy.simple(this.url.unbind, param);
8468
+ }
8469
+ /**
8470
+ * Возвращает описание полей связи записи таймлайна с элементом CRM.
8471
+ *
8472
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/bindings/crm-timeline-bindings-fields.html
8473
+ */
8474
+ fields() {
8475
+ return this.Navvy.simple(this.url.fields);
8476
+ }
8477
+ }
8478
+
8479
+ /** Комментарии таймлайна (`crm.timeline.comment.*`). */
8480
+ class BXRestNavvyCrmTimelineComment {
8481
+ constructor() {
8482
+ this.Navvy = new Navvy();
8483
+ this.url = {
8484
+ /** Добавляет новый комментарий в таймлайн. */
8485
+ add: [$crm, $timeline, $comment, $add],
8486
+ /** Обновляет текст и/или файлы комментария. */
8487
+ update: [$crm, $timeline, $comment, $update],
8488
+ /** Возвращает комментарий по идентификатору. */
8489
+ get: [$crm, $timeline, $comment, $get],
8490
+ /** Возвращает комментарии указанного элемента CRM. */
8491
+ list: [$crm, $timeline, $comment, $list],
8492
+ /** Удаляет комментарий или его отдельную привязку. */
8493
+ delete: [$crm, $timeline, $comment, $delete],
8494
+ /** Возвращает формальное описание полей комментария. */
8495
+ fields: [$crm, $timeline, $comment, 'fields']
8496
+ };
8497
+ }
8498
+ /**
8499
+ * Добавляет новый комментарий в таймлайн элемента CRM.
8500
+ *
8501
+ * Содержимое файлов передается в Base64. Начиная с CRM 23.100.0 внешний ключ
8502
+ * параметров должен называться именно `fields` в нижнем регистре.
8503
+ *
8504
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-add.html
8505
+ */
8506
+ add(param) {
8507
+ return this.Navvy.simple(this.url.add, param);
8508
+ }
8509
+ /**
8510
+ * Обновляет текст и/или прикрепленные файлы комментария.
8511
+ *
8512
+ * `ownerTypeId` и `ownerId` уточняют элемент CRM, когда комментарий связан
8513
+ * сразу с несколькими элементами.
8514
+ *
8515
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-update.html
8516
+ */
8517
+ update(param) {
8518
+ return this.Navvy.simple(this.url.update, param);
8519
+ }
8520
+ /**
8521
+ * Возвращает комментарий по его идентификатору.
8522
+ *
8523
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-get.html
8524
+ */
8525
+ get(param) {
8526
+ return this.Navvy.simple(this.url.get, param);
8527
+ }
8528
+ /**
8529
+ * Возвращает комментарии указанного элемента CRM с выборкой полей,
8530
+ * сортировкой и постраничной навигацией.
8531
+ *
8532
+ * Размер страницы REST API фиксирован и равен 50 записям.
8533
+ *
8534
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-list.html
8535
+ */
8536
+ list(param) {
8537
+ return this.Navvy.pagNav(this.url.list, param);
8538
+ }
8539
+ /**
8540
+ * Удаляет комментарий.
8541
+ *
8542
+ * Если передать `ownerTypeId` и `ownerId`, у комментария с несколькими
8543
+ * связями будет удалена только привязка к указанному элементу.
8544
+ *
8545
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-delete.html
8546
+ */
8547
+ delete(param) {
8548
+ return this.Navvy.simple(this.url.delete, param);
8549
+ }
8550
+ /**
8551
+ * Возвращает описание всех полей комментария таймлайна.
8552
+ *
8553
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/comments/crm-timeline-comment-fields.html
8554
+ */
8555
+ fields() {
8556
+ return this.Navvy.simple(this.url.fields);
8557
+ }
8558
+ }
8559
+
8560
+ /** Иконки лог-записей (`crm.timeline.icon.*`). */
8561
+ class BXRestNavvyCrmTimelineIcon {
8562
+ constructor() {
8563
+ this.Navvy = new Navvy();
8564
+ this.url = {
8565
+ /** Добавляет пользовательскую иконку. */
8566
+ add: [$crm, $timeline, $icon, $add],
8567
+ /** Возвращает иконку по коду. */
8568
+ get: [$crm, $timeline, $icon, $get],
8569
+ /** Возвращает системные и пользовательские иконки. */
8570
+ list: [$crm, $timeline, $icon, $list],
8571
+ /** Удаляет пользовательскую иконку. */
8572
+ delete: [$crm, $timeline, $icon, $delete]
8573
+ };
8574
+ }
8575
+ /**
8576
+ * Добавляет пользовательскую иконку лог-записи.
8577
+ *
8578
+ * Метод доступен только администратору. Передайте прозрачный PNG 24×24 пикселя
8579
+ * в виде Base64-строки.
8580
+ *
8581
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-add.html
8582
+ */
8583
+ add(param) {
8584
+ return this.Navvy.simple(this.url.add, param);
8585
+ }
8586
+ /**
8587
+ * Возвращает системную или пользовательскую иконку по коду.
8588
+ *
8589
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-get.html
8590
+ */
8591
+ get(param) {
8592
+ return this.Navvy.simple(this.url.get, param);
8593
+ }
8594
+ /**
8595
+ * Возвращает список всех доступных системных и пользовательских иконок.
8596
+ *
8597
+ * Поле `isSystem` отличает встроенную иконку от добавленной приложением.
8598
+ *
8599
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-list.html
8600
+ */
8601
+ list() {
8602
+ return this.Navvy.simple(this.url.list);
8603
+ }
8604
+ /**
8605
+ * Удаляет пользовательскую иконку. Системные иконки удалить нельзя.
8606
+ *
8607
+ * Метод доступен только администратору.
8608
+ *
8609
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-delete.html
8610
+ */
8611
+ delete(param) {
8612
+ return this.Navvy.simple(this.url.delete, param);
8613
+ }
8614
+ }
8615
+
8616
+ /** Действия над записями таймлайна (`crm.timeline.item.*`). */
8617
+ class BXRestNavvyCrmTimelineItem {
8618
+ constructor() {
8619
+ this.Navvy = new Navvy();
8620
+ this.url = {
8621
+ /** Закрепляет запись в таймлайне элемента CRM. */
8622
+ pin: [$crm, $timeline, $item, $pin],
8623
+ /** Открепляет запись в таймлайне элемента CRM. */
8624
+ unpin: [$crm, $timeline, $item, $unpin]
8625
+ };
8626
+ }
8627
+ /**
8628
+ * Закрепляет запись в таймлайне указанного элемента CRM.
8629
+ *
8630
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/timeline-item/crm-timeline-item-pin.html
8631
+ */
8632
+ pin(param) {
8633
+ return this.Navvy.simple(this.url.pin, param);
8634
+ }
8635
+ /**
8636
+ * Открепляет запись в таймлайне указанного элемента CRM.
8637
+ *
8638
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/timeline-item/crm-timeline-item-unpin.html
8639
+ */
8640
+ unpin(param) {
8641
+ return this.Navvy.simple(this.url.unpin, param);
8642
+ }
8643
+ }
8644
+
8645
+ /** Дополнительные контентные блоки записи таймлайна (`crm.timeline.layout.blocks.*`). */
8646
+ class BXRestNavvyCrmTimelineLayoutBlocks {
8647
+ constructor() {
8648
+ this.Navvy = new Navvy();
8649
+ this.url = {
8650
+ /** Устанавливает полный набор блоков текущего приложения. */
8651
+ set: [$crm, $timeline, $layout, $blocks, $set],
8652
+ /** Возвращает набор блоков текущего приложения. */
8653
+ get: [$crm, $timeline, $layout, $blocks, $get],
8654
+ /** Удаляет набор блоков текущего приложения. */
8655
+ delete: [$crm, $timeline, $layout, $blocks, $delete]
8656
+ };
8657
+ }
8658
+ /**
8659
+ * Устанавливает набор дополнительных контентных блоков в запись таймлайна.
8660
+ *
8661
+ * Новый вызов полностью заменяет набор, ранее установленный тем же приложением.
8662
+ * Метод доступен администратору и не применяется к делам, лог-записям и
8663
+ * устаревшим типам записей таймлайна.
8664
+ *
8665
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/layout/blocks/crm-timeline-layout-blocks-set.html
8666
+ */
8667
+ set(param) {
8668
+ return this.Navvy.simple(this.url.set, param);
8669
+ }
8670
+ /**
8671
+ * Возвращает набор дополнительных контентных блоков, установленный текущим приложением.
8672
+ *
8673
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/layout/blocks/crm-timeline-layout-blocks-get.html
8674
+ */
8675
+ get(param) {
8676
+ return this.Navvy.simple(this.url.get, param);
8677
+ }
8678
+ /**
8679
+ * Удаляет набор дополнительных контентных блоков текущего приложения.
8680
+ *
8681
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/layout/blocks/crm-timeline-layout-blocks-delete.html
8682
+ */
8683
+ delete(param) {
8684
+ return this.Navvy.simple(this.url.delete, param);
8685
+ }
8686
+ }
8687
+
8688
+ /** Визуальное расширение записей таймлайна (`crm.timeline.layout.*`). */
8689
+ class BXRestNavvyCrmTimelineLayout {
8690
+ constructor() {
8691
+ /** Дополнительные контентные блоки записи. */
8692
+ this.blocks = new BXRestNavvyCrmTimelineLayoutBlocks();
8693
+ }
8694
+ }
8695
+
8696
+ /** Лог-записи приложения в таймлайне (`crm.timeline.logmessage.*`). */
8697
+ class BXRestNavvyCrmTimelineLogMessage {
8698
+ constructor() {
8699
+ this.Navvy = new Navvy();
8700
+ this.url = {
8701
+ /** Добавляет лог-запись приложения. */
8702
+ add: [$crm, $timeline, $logmessage, $add],
8703
+ /** Возвращает лог-запись по идентификатору. */
8704
+ get: [$crm, $timeline, $logmessage, $get],
8705
+ /** Возвращает лог-записи приложения для элемента CRM. */
8706
+ list: [$crm, $timeline, $logmessage, $list],
8707
+ /** Удаляет лог-запись приложения. */
8708
+ delete: [$crm, $timeline, $logmessage, $delete]
8709
+ };
8710
+ }
8711
+ /**
8712
+ * Добавляет новую лог-запись приложения в таймлайн элемента CRM.
8713
+ *
8714
+ * Значение `iconCode` должно присутствовать в результате `crm.timeline.icon.list`.
8715
+ *
8716
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-add.html
8717
+ */
8718
+ add(param) {
8719
+ return this.Navvy.simple(this.url.add, param);
8720
+ }
8721
+ /**
8722
+ * Возвращает лог-запись, ранее добавленную приложением.
8723
+ *
8724
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-get.html
8725
+ */
8726
+ get(param) {
8727
+ return this.Navvy.simple(this.url.get, param);
8728
+ }
8729
+ /**
8730
+ * Возвращает лог-записи приложения для указанного элемента CRM.
8731
+ *
8732
+ * Системные записи метод не возвращает. Размер страницы REST API фиксирован
8733
+ * и равен 10 записям; `resAll()` учитывает этот размер.
8734
+ *
8735
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-list.html
8736
+ */
8737
+ list(param) {
8738
+ const request = this.Navvy.pagNav(this.url.list, param);
8739
+ request.pageSize = 10;
8740
+ return request;
8741
+ }
8742
+ /**
8743
+ * Удаляет лог-запись, ранее добавленную приложением.
8744
+ *
8745
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-delete.html
8746
+ */
8747
+ delete(param) {
8748
+ return this.Navvy.simple(this.url.delete, param);
8749
+ }
8750
+ }
8751
+
8752
+ /** Логотипы лог-записей (`crm.timeline.logo.*`). */
8753
+ class BXRestNavvyCrmTimelineLogo {
8754
+ constructor() {
8755
+ this.Navvy = new Navvy();
8756
+ this.url = {
8757
+ /** Добавляет пользовательский логотип. */
8758
+ add: [$crm, $timeline, $logo, $add],
8759
+ /** Возвращает логотип по коду. */
8760
+ get: [$crm, $timeline, $logo, $get],
8761
+ /** Возвращает системные и пользовательские логотипы. */
8762
+ list: [$crm, $timeline, $logo, $list],
8763
+ /** Удаляет пользовательский логотип. */
8764
+ delete: [$crm, $timeline, $logo, $delete]
8765
+ };
8766
+ }
8767
+ /**
8768
+ * Добавляет пользовательский логотип лог-записи.
8769
+ *
8770
+ * Метод доступен только администратору. Передайте прозрачный PNG 60×60 пикселей
8771
+ * в виде Base64-строки.
8772
+ *
8773
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-add.html
8774
+ */
8775
+ add(param) {
8776
+ return this.Navvy.simple(this.url.add, param);
8777
+ }
8778
+ /**
8779
+ * Возвращает системный или пользовательский логотип по коду.
8780
+ *
8781
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-get.html
8782
+ */
8783
+ get(param) {
8784
+ return this.Navvy.simple(this.url.get, param);
8785
+ }
8786
+ /**
8787
+ * Возвращает список всех доступных системных и пользовательских логотипов.
8788
+ *
8789
+ * Поле `isSystem` отличает встроенный логотип от добавленного приложением.
8790
+ *
8791
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-list.html
8792
+ */
8793
+ list() {
8794
+ return this.Navvy.simple(this.url.list);
8795
+ }
8796
+ /**
8797
+ * Удаляет пользовательский логотип. Системные логотипы удалить нельзя.
8798
+ *
8799
+ * Метод доступен только администратору.
8800
+ *
8801
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-delete.html
8802
+ */
8803
+ delete(param) {
8804
+ return this.Navvy.simple(this.url.delete, param);
8805
+ }
8806
+ }
8807
+
8808
+ /** Заметки к записям таймлайна и делам (`crm.timeline.note.*`). */
8809
+ class BXRestNavvyCrmTimelineNote {
8810
+ constructor() {
8811
+ this.Navvy = new Navvy();
8812
+ this.url = {
8813
+ /** Возвращает заметку к записи таймлайна или делу. */
8814
+ get: [$crm, $timeline, $note, $get],
8815
+ /** Создает или обновляет заметку. */
8816
+ save: [$crm, $timeline, $note, $save],
8817
+ /** Удаляет заметку. */
8818
+ delete: [$crm, $timeline, $note, $delete]
8819
+ };
8820
+ }
8821
+ /**
8822
+ * Возвращает заметку к записи истории таймлайна или делу CRM.
8823
+ *
8824
+ * В `itemType` передайте `1` для записи истории или `2` для дела.
8825
+ *
8826
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-get.html
8827
+ */
8828
+ get(param) {
8829
+ return this.Navvy.simple(this.url.get, param);
8830
+ }
8831
+ /**
8832
+ * Создает заметку или заменяет текст существующей.
8833
+ *
8834
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-save.html
8835
+ */
8836
+ save(param) {
8837
+ return this.Navvy.simple(this.url.save, param);
8838
+ }
8839
+ /**
8840
+ * Удаляет заметку у записи истории таймлайна или дела CRM.
8841
+ *
8842
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/timeline/note/crm-timeline-note-delete.html
8843
+ */
8844
+ delete(param) {
8845
+ return this.Navvy.simple(this.url.delete, param);
8846
+ }
8847
+ }
8848
+
8849
+ /** Таймлайн CRM: комментарии, заметки, связи и лог-записи (`crm.timeline.*`). */
8850
+ class BXRestNavvyCrmTimeline {
8851
+ constructor() {
8852
+ /** Комментарии таймлайна. */
8853
+ this.comment = new BXRestNavvyCrmTimelineComment();
8854
+ /** Заметки к записям таймлайна и делам. */
8855
+ this.note = new BXRestNavvyCrmTimelineNote();
8856
+ /** Связи записей таймлайна с элементами CRM. */
8857
+ this.bindings = new BXRestNavvyCrmTimelineBindings();
8858
+ /** Дополнительные контентные блоки записей. */
8859
+ this.layout = new BXRestNavvyCrmTimelineLayout();
8860
+ /** Лог-записи приложения. */
8861
+ this.logMessage = new BXRestNavvyCrmTimelineLogMessage();
8862
+ /** Иконки лог-записей. */
8863
+ this.icon = new BXRestNavvyCrmTimelineIcon();
8864
+ /** Логотипы лог-записей. */
8865
+ this.logo = new BXRestNavvyCrmTimelineLogo();
8866
+ /** Закрепление и открепление записей. */
8867
+ this.item = new BXRestNavvyCrmTimelineItem();
8868
+ }
8869
+ }
8870
+
8171
8871
  class BXRestNavvyCrm {
8172
8872
  constructor() {
8873
+ /** Таймлайн CRM: комментарии, заметки, связи и лог-записи (`crm.timeline.*`). */
8874
+ this.timeline = new BXRestNavvyCrmTimeline();
8173
8875
  /** Адреса CRM, в том числе адреса реквизитов (`crm.address.*`). */
8174
8876
  this.address = new BXRestNavvyCrmAddress();
8175
8877
  /** Реквизиты, банковские данные, связи и шаблоны (`crm.requisite.*`). */