bx-rest 0.10.7 → 0.11.1
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.
- package/README.md +388 -263
- package/consts/part-name-methods.d.ts +4 -0
- package/esm2022/consts/part-name-methods.mjs +5 -1
- package/esm2022/request-navvy/bizproc/activity.mjs +64 -0
- package/esm2022/request-navvy/bizproc/event.mjs +24 -0
- package/esm2022/request-navvy/bizproc/robot.mjs +51 -0
- package/esm2022/request-navvy/bizproc/task.mjs +25 -7
- package/esm2022/request-navvy/bizproc/workflow/template.mjs +54 -0
- package/esm2022/request-navvy/bizproc/workflow.mjs +31 -9
- package/esm2022/request-navvy/bizproc.mjs +13 -1
- package/esm2022/request-navvy/event/offline.mjs +61 -0
- package/esm2022/request-navvy/event.mjs +69 -0
- package/esm2022/rest/navvy.mjs +4 -1
- package/esm2022/typification/rest/bizproc/activity.mjs +2 -0
- package/esm2022/typification/rest/bizproc/base/registration.mjs +2 -0
- package/esm2022/typification/rest/bizproc/event.mjs +2 -0
- package/esm2022/typification/rest/bizproc/robot.mjs +2 -0
- package/esm2022/typification/rest/bizproc/task/complete.mjs +1 -1
- package/esm2022/typification/rest/bizproc/task/delegate.mjs +1 -1
- package/esm2022/typification/rest/bizproc/workflow/kill.mjs +1 -1
- package/esm2022/typification/rest/bizproc/workflow/start.mjs +1 -1
- package/esm2022/typification/rest/bizproc/workflow/template/add.mjs +2 -0
- package/esm2022/typification/rest/bizproc/workflow/template/delete.mjs +2 -0
- package/esm2022/typification/rest/bizproc/workflow/template/list.mjs +1 -1
- package/esm2022/typification/rest/bizproc/workflow/template/update.mjs +2 -0
- package/esm2022/typification/rest/bizproc/workflow/terminate.mjs +1 -1
- package/esm2022/typification/rest/bizproc.mjs +8 -1
- package/esm2022/typification/rest/event.mjs +2 -0
- package/esm2022/typification/rest/user/user.mjs +1 -1
- package/fesm2022/bx-rest.mjs +382 -14
- package/fesm2022/bx-rest.mjs.map +1 -1
- package/package.json +4 -1
- package/request-navvy/bizproc/activity.d.ts +50 -0
- package/request-navvy/bizproc/event.d.ts +18 -0
- package/request-navvy/bizproc/robot.d.ts +39 -0
- package/request-navvy/bizproc/task.d.ts +21 -3
- package/request-navvy/bizproc/workflow/template.d.ts +42 -0
- package/request-navvy/bizproc/workflow.d.ts +26 -4
- package/request-navvy/bizproc.d.ts +12 -0
- package/request-navvy/event/offline.d.ts +49 -0
- package/request-navvy/event.d.ts +57 -0
- package/rest/navvy.d.ts +3 -0
- package/typification/rest/bizproc/activity.d.ts +25 -0
- package/typification/rest/bizproc/base/registration.d.ts +66 -0
- package/typification/rest/bizproc/event.d.ts +9 -0
- package/typification/rest/bizproc/robot.d.ts +18 -0
- package/typification/rest/bizproc/task/complete.d.ts +6 -0
- package/typification/rest/bizproc/task/delegate.d.ts +4 -0
- package/typification/rest/bizproc/workflow/kill.d.ts +3 -1
- package/typification/rest/bizproc/workflow/start.d.ts +9 -1
- package/typification/rest/bizproc/workflow/template/add.d.ts +21 -0
- package/typification/rest/bizproc/workflow/template/delete.d.ts +5 -0
- package/typification/rest/bizproc/workflow/template/list.d.ts +32 -6
- package/typification/rest/bizproc/workflow/template/update.d.ts +19 -0
- package/typification/rest/bizproc/workflow/terminate.d.ts +3 -0
- package/typification/rest/bizproc.d.ts +7 -0
- package/typification/rest/event.d.ts +178 -0
- 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.
|
|
3
|
+
"version": "0.11.1",
|
|
4
4
|
"description": "Bitrix24 REST API client and TypeScript SDK for Angular, Vue and browser apps",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"bitrix",
|
|
@@ -74,6 +74,9 @@
|
|
|
74
74
|
"./typification/disk": {
|
|
75
75
|
"types": "./typification/rest/disk.d.ts"
|
|
76
76
|
},
|
|
77
|
+
"./typification/event": {
|
|
78
|
+
"types": "./typification/rest/event.d.ts"
|
|
79
|
+
},
|
|
77
80
|
"./typification/im": {
|
|
78
81
|
"types": "./typification/rest/im.d.ts"
|
|
79
82
|
},
|
|
@@ -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,49 @@
|
|
|
1
|
+
import { iBXRestEventOfflineGetResult, iBXRestEventOfflineListItem, iBXRestParamEventOfflineClear, iBXRestParamEventOfflineError, iBXRestParamEventOfflineGet, iBXRestParamEventOfflineList } from '../../typification/rest/event';
|
|
2
|
+
/** Очередь офлайн-событий (`event.offline.*`). Доступна администраторам. */
|
|
3
|
+
export declare class BXRestNavvyEventOffline {
|
|
4
|
+
private readonly Navvy;
|
|
5
|
+
readonly url: {
|
|
6
|
+
/** Возвращает и удаляет либо резервирует первые записи очереди. */
|
|
7
|
+
get: string[];
|
|
8
|
+
/** Возвращает страницу очереди, не меняя состояние записей. */
|
|
9
|
+
list: string[];
|
|
10
|
+
/** Удаляет обработанные записи зарезервированного пакета. */
|
|
11
|
+
clear: string[];
|
|
12
|
+
/** Помечает записи зарезервированного пакета ошибочными. */
|
|
13
|
+
error: string[];
|
|
14
|
+
};
|
|
15
|
+
/**
|
|
16
|
+
* Возвращает первые записи очереди согласно фильтру.
|
|
17
|
+
*
|
|
18
|
+
* По умолчанию метод удаляет выбранные записи. Передайте `clear: 0`, чтобы
|
|
19
|
+
* зарезервировать их и получить `process_id` для последующего вызова
|
|
20
|
+
* `clear` или `error`. Параллельные запросы получают разные наборы записей.
|
|
21
|
+
*
|
|
22
|
+
* @see https://apidocs.bitrix24.ru/api-reference/events/event-offline-get.html
|
|
23
|
+
*/
|
|
24
|
+
get(param?: iBXRestParamEventOfflineGet): import("../../services/navvy").NavvySimple<iBXRestEventOfflineGetResult, iBXRestEventOfflineGetResult, iBXRestParamEventOfflineGet | undefined>;
|
|
25
|
+
/**
|
|
26
|
+
* Читает одну страницу текущей очереди, не меняя состояние записей.
|
|
27
|
+
*
|
|
28
|
+
* Метод не резервирует записи и не формирует `process_id`. Размер страницы
|
|
29
|
+
* фиксирован и равен 50 записям.
|
|
30
|
+
*
|
|
31
|
+
* @see https://apidocs.bitrix24.ru/api-reference/events/event-offline-list.html
|
|
32
|
+
*/
|
|
33
|
+
list(param?: iBXRestParamEventOfflineList): import("../../services/navvy").NavvyPag<iBXRestEventOfflineListItem, iBXRestEventOfflineListItem, iBXRestParamEventOfflineList>;
|
|
34
|
+
/**
|
|
35
|
+
* Удаляет обработанные записи зарезервированного пакета.
|
|
36
|
+
*
|
|
37
|
+
* Без `id` и `message_id` удаляет все записи с переданным `process_id`.
|
|
38
|
+
* Если указаны оба массива, `id` имеет приоритет.
|
|
39
|
+
*
|
|
40
|
+
* @see https://apidocs.bitrix24.ru/api-reference/events/event-offline-clear.html
|
|
41
|
+
*/
|
|
42
|
+
clear(param: iBXRestParamEventOfflineClear): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamEventOfflineClear | undefined>;
|
|
43
|
+
/**
|
|
44
|
+
* Помечает записи зарезервированного пакета ошибочными.
|
|
45
|
+
*
|
|
46
|
+
* @see https://apidocs.bitrix24.ru/api-reference/events/event-offline-error.html
|
|
47
|
+
*/
|
|
48
|
+
error(param: iBXRestParamEventOfflineError): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamEventOfflineError | undefined>;
|
|
49
|
+
}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { iBXRestEventHandler, iBXRestEventUnbindResult, iBXRestParamEventBind, iBXRestParamEventUnbind, iBXRestParamEvents } from '../typification/rest/event';
|
|
2
|
+
import { BXRestNavvyEventOffline } from './event/offline';
|
|
3
|
+
/** Регистрация обработчиков и работа с событиями Битрикс24. */
|
|
4
|
+
export declare class BXRestNavvyEvent {
|
|
5
|
+
private readonly Navvy;
|
|
6
|
+
/** Очередь офлайн-событий. Для вызовов требуются права администратора. */
|
|
7
|
+
readonly offline: BXRestNavvyEventOffline;
|
|
8
|
+
readonly url: {
|
|
9
|
+
/** Регистрирует обработчик события. */
|
|
10
|
+
bind: string[];
|
|
11
|
+
/** Возвращает зарегистрированные обработчики приложения. */
|
|
12
|
+
get: string[];
|
|
13
|
+
/** Удаляет зарегистрированный обработчик. */
|
|
14
|
+
unbind: string[];
|
|
15
|
+
/** Возвращает доступные текущему приложению события. */
|
|
16
|
+
events: string[];
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* Регистрирует новый обработчик события.
|
|
20
|
+
*
|
|
21
|
+
* Метод работает только в контексте авторизации приложения. URL обработчика
|
|
22
|
+
* должен быть доступен серверам Битрикс24 извне. Пользователь без прав
|
|
23
|
+
* администратора может регистрировать только онлайн-события от своего имени.
|
|
24
|
+
*
|
|
25
|
+
* @see https://apidocs.bitrix24.ru/api-reference/events/event-bind.html
|
|
26
|
+
*/
|
|
27
|
+
bind(param: iBXRestParamEventBind): import("../services/navvy").NavvySimple<boolean, boolean, iBXRestParamEventBind | undefined>;
|
|
28
|
+
/**
|
|
29
|
+
* Возвращает список зарегистрированных обработчиков событий.
|
|
30
|
+
*
|
|
31
|
+
* Пользователь без прав администратора получает только обработчики,
|
|
32
|
+
* зарегистрированные для него. Метод работает только в контексте авторизации
|
|
33
|
+
* приложения.
|
|
34
|
+
*
|
|
35
|
+
* @see https://apidocs.bitrix24.ru/api-reference/events/event-get.html
|
|
36
|
+
*/
|
|
37
|
+
get(): import("../services/navvy").NavvySimple<iBXRestEventHandler[], iBXRestEventHandler[], undefined>;
|
|
38
|
+
/**
|
|
39
|
+
* Удаляет зарегистрированный обработчик события.
|
|
40
|
+
*
|
|
41
|
+
* Пользователь без прав администратора может удалять только собственные
|
|
42
|
+
* обработчики онлайн-событий.
|
|
43
|
+
*
|
|
44
|
+
* @see https://apidocs.bitrix24.ru/api-reference/events/event-unbind.html
|
|
45
|
+
*/
|
|
46
|
+
unbind(param: iBXRestParamEventUnbind): import("../services/navvy").NavvySimple<iBXRestEventUnbindResult, iBXRestEventUnbindResult, iBXRestParamEventUnbind | undefined>;
|
|
47
|
+
/**
|
|
48
|
+
* Возвращает общий список доступных событий.
|
|
49
|
+
*
|
|
50
|
+
* `SCOPE` ограничивает результат указанным разрешением. `FULL: true`
|
|
51
|
+
* запрашивает полный список, но игнорируется при одновременной передаче
|
|
52
|
+
* `SCOPE`.
|
|
53
|
+
*
|
|
54
|
+
* @see https://apidocs.bitrix24.ru/api-reference/events/events.html
|
|
55
|
+
*/
|
|
56
|
+
events(param?: iBXRestParamEvents): import("../services/navvy").NavvySimple<string[], string[], iBXRestParamEvents | undefined>;
|
|
57
|
+
}
|
package/rest/navvy.d.ts
CHANGED
|
@@ -16,6 +16,7 @@ import { BXRestNavvyTimeMan } from '../request-navvy/timeman';
|
|
|
16
16
|
import { BXRestNavvySocialNetWork } from '../request-navvy/socialnetwork';
|
|
17
17
|
import { BXRestNavvyPull } from '../request-navvy/pull';
|
|
18
18
|
import { BXRestNavvyCrm } from '../request-navvy/crm';
|
|
19
|
+
import { BXRestNavvyEvent } from '../request-navvy/event';
|
|
19
20
|
import { iBXRestProfile, iBXRestProfileHttp } from '../typification/rest/profile';
|
|
20
21
|
export declare class BXRestNavvy {
|
|
21
22
|
readonly user: BXRestNavvyUser;
|
|
@@ -35,6 +36,8 @@ export declare class BXRestNavvy {
|
|
|
35
36
|
readonly socialNetWork: BXRestNavvySocialNetWork;
|
|
36
37
|
readonly pull: BXRestNavvyPull;
|
|
37
38
|
readonly crm: BXRestNavvyCrm;
|
|
39
|
+
/** Регистрация обработчиков и работа с онлайн- и офлайн-событиями. */
|
|
40
|
+
readonly event: BXRestNavvyEvent;
|
|
38
41
|
readonly Navvy: Navvy;
|
|
39
42
|
profile(): import("../services/navvy").NavvySimple<iBXRestProfileHttp, iBXRestProfile, undefined>;
|
|
40
43
|
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { iBXRestBizprocRegistrationFields } from './base/registration';
|
|
2
|
+
/** Параметры `bizproc.activity.add`. */
|
|
3
|
+
export interface iBXRestParamBizprocActivityAdd extends iBXRestBizprocRegistrationFields {
|
|
4
|
+
/** Уникальный в рамках приложения символьный код действия. */
|
|
5
|
+
CODE: string;
|
|
6
|
+
}
|
|
7
|
+
/** Параметры `bizproc.activity.update`. */
|
|
8
|
+
export interface iBXRestParamBizprocActivityUpdate {
|
|
9
|
+
/** Символьный код зарегистрированного действия. */
|
|
10
|
+
CODE: string;
|
|
11
|
+
/** Новые поля действия. */
|
|
12
|
+
FIELDS: iBXRestBizprocRegistrationFields;
|
|
13
|
+
}
|
|
14
|
+
/** Параметры `bizproc.activity.delete`. */
|
|
15
|
+
export interface iBXRestParamBizprocActivityDelete {
|
|
16
|
+
/** Символьный код зарегистрированного действия. */
|
|
17
|
+
CODE: string;
|
|
18
|
+
}
|
|
19
|
+
/** Параметры `bizproc.activity.log`. */
|
|
20
|
+
export interface iBXRestParamBizprocActivityLog {
|
|
21
|
+
/** Актуальный токен события, полученный обработчиком действия. */
|
|
22
|
+
EVENT_TOKEN: string;
|
|
23
|
+
/** Сообщение для журнала бизнес-процесса. */
|
|
24
|
+
LOG_MESSAGE: string;
|
|
25
|
+
}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import { iBXRestYesNo } from '../../base/yes-no';
|
|
2
|
+
/** Строка или набор ее локализованных вариантов. */
|
|
3
|
+
export type iBXRestBizprocLocalizedString = string | Record<string, string>;
|
|
4
|
+
/**
|
|
5
|
+
* Тип документа в формате `[модуль, объект, тип документа]`.
|
|
6
|
+
*
|
|
7
|
+
* @example ['crm', 'CCrmDocumentDeal', 'DEAL']
|
|
8
|
+
*/
|
|
9
|
+
export type iBXRestBizprocDocumentType = [
|
|
10
|
+
moduleId: string,
|
|
11
|
+
entity: string,
|
|
12
|
+
documentType: string
|
|
13
|
+
];
|
|
14
|
+
/** Правило доступности действия или робота для документа либо редакции Битрикс24. */
|
|
15
|
+
export type iBXRestBizprocRegistrationFilterRule = string | string[];
|
|
16
|
+
/** Ограничения видимости действия или робота. */
|
|
17
|
+
export interface iBXRestBizprocRegistrationFilter {
|
|
18
|
+
/** Правила, для которых действие или робот отображается. */
|
|
19
|
+
INCLUDE?: iBXRestBizprocRegistrationFilterRule[];
|
|
20
|
+
/** Правила, для которых действие или робот скрывается. */
|
|
21
|
+
EXCLUDE?: iBXRestBizprocRegistrationFilterRule[];
|
|
22
|
+
}
|
|
23
|
+
/** Базовые типы параметров действия или робота. */
|
|
24
|
+
export type iBXRestBizprocRegistrationPropertyType = 'bool' | 'date' | 'datetime' | 'double' | 'file' | 'int' | 'select' | 'string' | 'text' | 'user';
|
|
25
|
+
/** Описание входного или выходного параметра действия либо робота. */
|
|
26
|
+
export interface iBXRestBizprocRegistrationProperty {
|
|
27
|
+
/** Отображаемое имя параметра. */
|
|
28
|
+
Name: iBXRestBizprocLocalizedString;
|
|
29
|
+
/** Описание параметра. */
|
|
30
|
+
Description?: iBXRestBizprocLocalizedString;
|
|
31
|
+
/** Тип данных параметра. */
|
|
32
|
+
Type: iBXRestBizprocRegistrationPropertyType | string;
|
|
33
|
+
/** Варианты значения для параметра типа `select`. */
|
|
34
|
+
Options?: Record<string, string> | string[];
|
|
35
|
+
/** Является ли параметр обязательным. */
|
|
36
|
+
Required?: iBXRestYesNo;
|
|
37
|
+
/** Допускает ли параметр несколько значений. */
|
|
38
|
+
Multiple?: iBXRestYesNo;
|
|
39
|
+
/** Значение по умолчанию. */
|
|
40
|
+
Default?: unknown;
|
|
41
|
+
}
|
|
42
|
+
/** Поля регистрации действия или робота приложения. */
|
|
43
|
+
export interface iBXRestBizprocRegistrationFields {
|
|
44
|
+
/** URL обработчика на домене установленного приложения. */
|
|
45
|
+
HANDLER: string;
|
|
46
|
+
/** Пользователь, чей токен будет передан обработчику. */
|
|
47
|
+
AUTH_USER_ID?: number;
|
|
48
|
+
/** Должен ли бизнес-процесс ожидать ответ приложения. */
|
|
49
|
+
USE_SUBSCRIPTION?: iBXRestYesNo;
|
|
50
|
+
/** Название действия или робота. */
|
|
51
|
+
NAME: iBXRestBizprocLocalizedString;
|
|
52
|
+
/** Описание действия или робота. */
|
|
53
|
+
DESCRIPTION?: iBXRestBizprocLocalizedString;
|
|
54
|
+
/** Входные параметры. */
|
|
55
|
+
PROPERTIES?: Record<string, iBXRestBizprocRegistrationProperty>;
|
|
56
|
+
/** Выходные параметры. */
|
|
57
|
+
RETURN_PROPERTIES?: Record<string, iBXRestBizprocRegistrationProperty>;
|
|
58
|
+
/** Тип документа, определяющий типы входных и выходных параметров. */
|
|
59
|
+
DOCUMENT_TYPE?: iBXRestBizprocDocumentType;
|
|
60
|
+
/** Ограничения по типу документа и редакции Битрикс24. */
|
|
61
|
+
FILTER?: iBXRestBizprocRegistrationFilter;
|
|
62
|
+
/** Включает дополнительные настройки во встройке приложения. */
|
|
63
|
+
USE_PLACEMENT?: iBXRestYesNo;
|
|
64
|
+
/** URL обработчика встройки; обязателен при `USE_PLACEMENT: 'Y'`. */
|
|
65
|
+
PLACEMENT_HANDLER?: string;
|
|
66
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/** Параметры `bizproc.event.send`. */
|
|
2
|
+
export interface iBXRestParamBizprocEventSend {
|
|
3
|
+
/** Актуальный токен события, полученный обработчиком действия или робота. */
|
|
4
|
+
EVENT_TOKEN: string;
|
|
5
|
+
/** Значения зарегистрированных выходных параметров. */
|
|
6
|
+
RETURN_VALUES?: Record<string, unknown>;
|
|
7
|
+
/** Сообщение для журнала бизнес-процесса. */
|
|
8
|
+
LOG_MESSAGE?: string;
|
|
9
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { iBXRestBizprocRegistrationFields } from './base/registration';
|
|
2
|
+
/** Параметры `bizproc.robot.add`. */
|
|
3
|
+
export interface iBXRestParamBizprocRobotAdd extends iBXRestBizprocRegistrationFields {
|
|
4
|
+
/** Уникальный в рамках приложения символьный код робота. */
|
|
5
|
+
CODE: string;
|
|
6
|
+
}
|
|
7
|
+
/** Параметры `bizproc.robot.update`. */
|
|
8
|
+
export interface iBXRestParamBizprocRobotUpdate {
|
|
9
|
+
/** Символьный код зарегистрированного робота. */
|
|
10
|
+
CODE: string;
|
|
11
|
+
/** Новые поля робота. */
|
|
12
|
+
FIELDS: iBXRestBizprocRegistrationFields;
|
|
13
|
+
}
|
|
14
|
+
/** Параметры `bizproc.robot.delete`. */
|
|
15
|
+
export interface iBXRestParamBizprocRobotDelete {
|
|
16
|
+
/** Символьный код зарегистрированного робота. */
|
|
17
|
+
CODE: string;
|
|
18
|
+
}
|
|
@@ -1,7 +1,13 @@
|
|
|
1
|
+
/** Допустимый результат выполнения задания бизнес-процесса. */
|
|
1
2
|
export type iBXRestBizprocTaskCompleteStatus = 1 | 2 | 3 | 4 | 'yes' | 'no' | 'ok' | 'cancel';
|
|
3
|
+
/** Параметры `bizproc.task.complete`. */
|
|
2
4
|
export interface iBXRestParamBizprocTaskComplete {
|
|
5
|
+
/** Идентификатор задания. */
|
|
3
6
|
TASK_ID: number;
|
|
7
|
+
/** Целевой статус задания. */
|
|
4
8
|
STATUS: iBXRestBizprocTaskCompleteStatus;
|
|
9
|
+
/** Комментарий пользователя. */
|
|
5
10
|
COMMENT?: string;
|
|
11
|
+
/** Значения полей задания с запросом дополнительной информации. */
|
|
6
12
|
FIELDS?: Record<string, unknown>;
|
|
7
13
|
}
|
|
@@ -1,5 +1,9 @@
|
|
|
1
|
+
/** Параметры `bizproc.task.delegate`. */
|
|
1
2
|
export interface iBXRestParamBizprocTaskDelegate {
|
|
3
|
+
/** Идентификаторы делегируемых заданий. */
|
|
2
4
|
TASK_IDS: number[];
|
|
5
|
+
/** Пользователь, от которого делегируются задания. */
|
|
3
6
|
FROM_USER_ID: number;
|
|
7
|
+
/** Пользователь, которому делегируются задания. */
|
|
4
8
|
TO_USER_ID: number;
|
|
5
9
|
}
|
|
@@ -1,5 +1,13 @@
|
|
|
1
|
+
/** Параметры `bizproc.workflow.start`. */
|
|
1
2
|
export interface iBXRestParamBizprocWorkflowStart {
|
|
3
|
+
/** Идентификатор шаблона бизнес-процесса. */
|
|
2
4
|
TEMPLATE_ID: number;
|
|
5
|
+
/**
|
|
6
|
+
* Документ в формате `[модуль, объект, идентификатор элемента]`.
|
|
7
|
+
*
|
|
8
|
+
* @example ['crm', 'CCrmDocumentDeal', 'DEAL_777']
|
|
9
|
+
*/
|
|
3
10
|
DOCUMENT_ID: string[];
|
|
4
|
-
|
|
11
|
+
/** Значения входных параметров шаблона. */
|
|
12
|
+
PARAMETERS?: Record<string, unknown>;
|
|
5
13
|
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { iBXRestBizprocDocumentType } from '../../base/registration';
|
|
2
|
+
/** Настройка автоматического запуска шаблона бизнес-процесса. */
|
|
3
|
+
export type iBXRestBizprocWorkflowTemplateAutoExecute = 0 | 1 | 2 | 3;
|
|
4
|
+
/** Файл шаблона в формате `[имя файла, содержимое Base64]`. */
|
|
5
|
+
export type iBXRestBizprocWorkflowTemplateFile = [
|
|
6
|
+
fileName: string,
|
|
7
|
+
base64Content: string
|
|
8
|
+
];
|
|
9
|
+
/** Параметры `bizproc.workflow.template.add`. */
|
|
10
|
+
export interface iBXRestParamBizprocWorkflowTemplateAdd {
|
|
11
|
+
/** Тип объектов, к которым будет привязан шаблон. */
|
|
12
|
+
DOCUMENT_TYPE: iBXRestBizprocDocumentType;
|
|
13
|
+
/** Название шаблона. */
|
|
14
|
+
NAME: string;
|
|
15
|
+
/** Описание шаблона. */
|
|
16
|
+
DESCRIPTION?: string;
|
|
17
|
+
/** Содержимое файла `.bpt`. */
|
|
18
|
+
TEMPLATE_DATA: iBXRestBizprocWorkflowTemplateFile;
|
|
19
|
+
/** Режим автозапуска; по умолчанию `0`. */
|
|
20
|
+
AUTO_EXECUTE?: iBXRestBizprocWorkflowTemplateAutoExecute;
|
|
21
|
+
}
|