@openfilz-sdk/typescript-ee 1.9.9 → 1.9.10
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/.openapi-generator/FILES +48 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +41 -3
- package/api/esign-api.ts +9 -9
- package/api/workflows-api.ts +1234 -0
- package/api.ts +1 -0
- package/dist/api/esign-api.d.ts +4 -4
- package/dist/api/esign-api.js +9 -9
- package/dist/api/workflows-api.d.ts +565 -0
- package/dist/api/workflows-api.js +1163 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/esm/api/esign-api.d.ts +4 -4
- package/dist/esm/api/esign-api.js +9 -9
- package/dist/esm/api/workflows-api.d.ts +565 -0
- package/dist/esm/api/workflows-api.js +1156 -0
- package/dist/esm/api.d.ts +1 -0
- package/dist/esm/api.js +1 -0
- package/dist/esm/models/audit-log-details.d.ts +12 -0
- package/dist/esm/models/cancel-instance-request.d.ts +14 -0
- package/dist/esm/models/cancel-instance-request.js +14 -0
- package/dist/esm/models/complete-task-request.d.ts +15 -0
- package/dist/esm/models/complete-task-request.js +14 -0
- package/dist/esm/models/enriched-audit-log-details.d.ts +7 -1
- package/dist/esm/models/enriched-audit-log.d.ts +9 -0
- package/dist/esm/models/enriched-audit-log.js +9 -0
- package/dist/esm/models/index.d.ts +23 -0
- package/dist/esm/models/index.js +23 -0
- package/dist/esm/models/my-tasks-count-dto.d.ts +15 -0
- package/dist/esm/models/my-tasks-count-dto.js +14 -0
- package/dist/esm/models/notification-dto.d.ts +4 -0
- package/dist/esm/models/notification-dto.js +4 -0
- package/dist/esm/models/per-definition.d.ts +18 -0
- package/dist/esm/models/per-definition.js +14 -0
- package/dist/esm/models/reassign-task-request.d.ts +15 -0
- package/dist/esm/models/reassign-task-request.js +14 -0
- package/dist/esm/models/save-workflow-definition-request.d.ts +19 -0
- package/dist/esm/models/save-workflow-definition-request.js +14 -0
- package/dist/esm/models/search-by-audit-log-request.d.ts +9 -0
- package/dist/esm/models/search-by-audit-log-request.js +9 -0
- package/dist/esm/models/settings.d.ts +3 -0
- package/dist/esm/models/start-workflow-request.d.ts +20 -0
- package/dist/esm/models/start-workflow-request.js +14 -0
- package/dist/esm/models/workflow-action-failure-audit.d.ts +17 -0
- package/dist/esm/models/workflow-action-failure-audit.js +14 -0
- package/dist/esm/models/workflow-action.d.ts +25 -0
- package/dist/esm/models/workflow-action.js +18 -0
- package/dist/esm/models/workflow-assignment.d.ts +24 -0
- package/dist/esm/models/workflow-assignment.js +19 -0
- package/dist/esm/models/workflow-audit.d.ts +17 -0
- package/dist/esm/models/workflow-audit.js +14 -0
- package/dist/esm/models/workflow-definition-dto.d.ts +26 -0
- package/dist/esm/models/workflow-definition-dto.js +14 -0
- package/dist/esm/models/workflow-event-dto.d.ts +35 -0
- package/dist/esm/models/workflow-event-dto.js +23 -0
- package/dist/esm/models/workflow-instance-detail-dto.d.ts +23 -0
- package/dist/esm/models/workflow-instance-detail-dto.js +14 -0
- package/dist/esm/models/workflow-instance-dto.d.ts +35 -0
- package/dist/esm/models/workflow-instance-dto.js +18 -0
- package/dist/esm/models/workflow-instance-page.d.ts +18 -0
- package/dist/esm/models/workflow-instance-page.js +14 -0
- package/dist/esm/models/workflow-problem.d.ts +17 -0
- package/dist/esm/models/workflow-problem.js +14 -0
- package/dist/esm/models/workflow-spec.d.ts +15 -0
- package/dist/esm/models/workflow-spec.js +14 -0
- package/dist/esm/models/workflow-state.d.ts +31 -0
- package/dist/esm/models/workflow-state.js +18 -0
- package/dist/esm/models/workflow-summary-dto.d.ts +19 -0
- package/dist/esm/models/workflow-summary-dto.js +14 -0
- package/dist/esm/models/workflow-task-dto.d.ts +44 -0
- package/dist/esm/models/workflow-task-dto.js +18 -0
- package/dist/esm/models/workflow-transition.d.ts +25 -0
- package/dist/esm/models/workflow-transition.js +19 -0
- package/dist/esm/models/workflow-validation-result.d.ts +16 -0
- package/dist/esm/models/workflow-validation-result.js +14 -0
- package/dist/models/audit-log-details.d.ts +12 -0
- package/dist/models/cancel-instance-request.d.ts +14 -0
- package/dist/models/cancel-instance-request.js +15 -0
- package/dist/models/complete-task-request.d.ts +15 -0
- package/dist/models/complete-task-request.js +15 -0
- package/dist/models/enriched-audit-log-details.d.ts +7 -1
- package/dist/models/enriched-audit-log.d.ts +9 -0
- package/dist/models/enriched-audit-log.js +9 -0
- package/dist/models/index.d.ts +23 -0
- package/dist/models/index.js +23 -0
- package/dist/models/my-tasks-count-dto.d.ts +15 -0
- package/dist/models/my-tasks-count-dto.js +15 -0
- package/dist/models/notification-dto.d.ts +4 -0
- package/dist/models/notification-dto.js +4 -0
- package/dist/models/per-definition.d.ts +18 -0
- package/dist/models/per-definition.js +15 -0
- package/dist/models/reassign-task-request.d.ts +15 -0
- package/dist/models/reassign-task-request.js +15 -0
- package/dist/models/save-workflow-definition-request.d.ts +19 -0
- package/dist/models/save-workflow-definition-request.js +15 -0
- package/dist/models/search-by-audit-log-request.d.ts +9 -0
- package/dist/models/search-by-audit-log-request.js +9 -0
- package/dist/models/settings.d.ts +3 -0
- package/dist/models/start-workflow-request.d.ts +20 -0
- package/dist/models/start-workflow-request.js +15 -0
- package/dist/models/workflow-action-failure-audit.d.ts +17 -0
- package/dist/models/workflow-action-failure-audit.js +15 -0
- package/dist/models/workflow-action.d.ts +25 -0
- package/dist/models/workflow-action.js +21 -0
- package/dist/models/workflow-assignment.d.ts +24 -0
- package/dist/models/workflow-assignment.js +22 -0
- package/dist/models/workflow-audit.d.ts +17 -0
- package/dist/models/workflow-audit.js +15 -0
- package/dist/models/workflow-definition-dto.d.ts +26 -0
- package/dist/models/workflow-definition-dto.js +15 -0
- package/dist/models/workflow-event-dto.d.ts +35 -0
- package/dist/models/workflow-event-dto.js +26 -0
- package/dist/models/workflow-instance-detail-dto.d.ts +23 -0
- package/dist/models/workflow-instance-detail-dto.js +15 -0
- package/dist/models/workflow-instance-dto.d.ts +35 -0
- package/dist/models/workflow-instance-dto.js +21 -0
- package/dist/models/workflow-instance-page.d.ts +18 -0
- package/dist/models/workflow-instance-page.js +15 -0
- package/dist/models/workflow-problem.d.ts +17 -0
- package/dist/models/workflow-problem.js +15 -0
- package/dist/models/workflow-spec.d.ts +15 -0
- package/dist/models/workflow-spec.js +15 -0
- package/dist/models/workflow-state.d.ts +31 -0
- package/dist/models/workflow-state.js +21 -0
- package/dist/models/workflow-summary-dto.d.ts +19 -0
- package/dist/models/workflow-summary-dto.js +15 -0
- package/dist/models/workflow-task-dto.d.ts +44 -0
- package/dist/models/workflow-task-dto.js +21 -0
- package/dist/models/workflow-transition.d.ts +25 -0
- package/dist/models/workflow-transition.js +22 -0
- package/dist/models/workflow-validation-result.d.ts +16 -0
- package/dist/models/workflow-validation-result.js +15 -0
- package/docs/AuditLogDetails.md +6 -0
- package/docs/CancelInstanceRequest.md +20 -0
- package/docs/CompleteTaskRequest.md +22 -0
- package/docs/ESignApi.md +4 -4
- package/docs/EnrichedAuditLogDetails.md +22 -0
- package/docs/MyTasksCountDTO.md +22 -0
- package/docs/PerDefinition.md +28 -0
- package/docs/ReassignTaskRequest.md +22 -0
- package/docs/SaveWorkflowDefinitionRequest.md +28 -0
- package/docs/Settings.md +6 -0
- package/docs/StartWorkflowRequest.md +28 -0
- package/docs/WorkflowAction.md +26 -0
- package/docs/WorkflowActionFailureAudit.md +25 -0
- package/docs/WorkflowAssignment.md +26 -0
- package/docs/WorkflowAudit.md +31 -0
- package/docs/WorkflowDefinitionDTO.md +42 -0
- package/docs/WorkflowEventDTO.md +36 -0
- package/docs/WorkflowInstanceDTO.md +48 -0
- package/docs/WorkflowInstanceDetailDTO.md +28 -0
- package/docs/WorkflowInstancePage.md +26 -0
- package/docs/WorkflowProblem.md +26 -0
- package/docs/WorkflowSpec.md +20 -0
- package/docs/WorkflowState.md +36 -0
- package/docs/WorkflowSummaryDTO.md +28 -0
- package/docs/WorkflowTaskDTO.md +66 -0
- package/docs/WorkflowTransition.md +28 -0
- package/docs/WorkflowValidationResult.md +22 -0
- package/docs/WorkflowsApi.md +791 -0
- package/graphql/document.graphqls +2 -0
- package/models/audit-log-details.ts +12 -0
- package/models/cancel-instance-request.ts +20 -0
- package/models/complete-task-request.ts +21 -0
- package/models/enriched-audit-log-details.ts +7 -1
- package/models/enriched-audit-log.ts +9 -0
- package/models/index.ts +23 -0
- package/models/my-tasks-count-dto.ts +21 -0
- package/models/notification-dto.ts +4 -0
- package/models/per-definition.ts +24 -0
- package/models/reassign-task-request.ts +21 -0
- package/models/save-workflow-definition-request.ts +27 -0
- package/models/search-by-audit-log-request.ts +9 -0
- package/models/settings.ts +3 -0
- package/models/start-workflow-request.ts +24 -0
- package/models/workflow-action-failure-audit.ts +26 -0
- package/models/workflow-action.ts +32 -0
- package/models/workflow-assignment.ts +33 -0
- package/models/workflow-audit.ts +26 -0
- package/models/workflow-definition-dto.ts +34 -0
- package/models/workflow-event-dto.ts +42 -0
- package/models/workflow-instance-detail-dto.ts +33 -0
- package/models/workflow-instance-dto.ts +46 -0
- package/models/workflow-instance-page.ts +26 -0
- package/models/workflow-problem.ts +23 -0
- package/models/workflow-spec.ts +23 -0
- package/models/workflow-state.ts +46 -0
- package/models/workflow-summary-dto.ts +27 -0
- package/models/workflow-task-dto.ts +55 -0
- package/models/workflow-transition.ts +34 -0
- package/models/workflow-validation-result.ts +24 -0
- package/package.json +1 -1
package/api.ts
CHANGED
package/dist/api/esign-api.d.ts
CHANGED
|
@@ -27,7 +27,7 @@ export declare const ESignApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
27
27
|
* @param {*} [options] Override http request option.
|
|
28
28
|
* @throws {RequiredError}
|
|
29
29
|
*/
|
|
30
|
-
|
|
30
|
+
cancel1: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
31
31
|
/**
|
|
32
32
|
*
|
|
33
33
|
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
@@ -111,7 +111,7 @@ export declare const ESignApiFp: (configuration?: Configuration) => {
|
|
|
111
111
|
* @param {*} [options] Override http request option.
|
|
112
112
|
* @throws {RequiredError}
|
|
113
113
|
*/
|
|
114
|
-
|
|
114
|
+
cancel1(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>>;
|
|
115
115
|
/**
|
|
116
116
|
*
|
|
117
117
|
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
@@ -195,7 +195,7 @@ export declare const ESignApiFactory: (configuration?: Configuration, basePath?:
|
|
|
195
195
|
* @param {*} [options] Override http request option.
|
|
196
196
|
* @throws {RequiredError}
|
|
197
197
|
*/
|
|
198
|
-
|
|
198
|
+
cancel1(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO>;
|
|
199
199
|
/**
|
|
200
200
|
*
|
|
201
201
|
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
@@ -279,7 +279,7 @@ export declare class ESignApi extends BaseAPI {
|
|
|
279
279
|
* @param {*} [options] Override http request option.
|
|
280
280
|
* @throws {RequiredError}
|
|
281
281
|
*/
|
|
282
|
-
|
|
282
|
+
cancel1(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}, any>>;
|
|
283
283
|
/**
|
|
284
284
|
*
|
|
285
285
|
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
package/dist/api/esign-api.js
CHANGED
|
@@ -41,9 +41,9 @@ const ESignApiAxiosParamCreator = function (configuration) {
|
|
|
41
41
|
* @param {*} [options] Override http request option.
|
|
42
42
|
* @throws {RequiredError}
|
|
43
43
|
*/
|
|
44
|
-
|
|
44
|
+
cancel1: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
45
45
|
// verify required parameter 'id' is not null or undefined
|
|
46
|
-
(0, common_1.assertParamExists)('
|
|
46
|
+
(0, common_1.assertParamExists)('cancel1', 'id', id);
|
|
47
47
|
const localVarPath = `/api/v1/signatures/{id}/cancel`
|
|
48
48
|
.replace('{id}', encodeURIComponent(String(id)));
|
|
49
49
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -377,12 +377,12 @@ const ESignApiFp = function (configuration) {
|
|
|
377
377
|
* @param {*} [options] Override http request option.
|
|
378
378
|
* @throws {RequiredError}
|
|
379
379
|
*/
|
|
380
|
-
|
|
380
|
+
cancel1(id, options) {
|
|
381
381
|
return __awaiter(this, void 0, void 0, function* () {
|
|
382
382
|
var _a, _b, _c;
|
|
383
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
383
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.cancel1(id, options);
|
|
384
384
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
385
|
-
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ESignApi.
|
|
385
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ESignApi.cancel1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
386
386
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
387
387
|
});
|
|
388
388
|
},
|
|
@@ -545,8 +545,8 @@ const ESignApiFactory = function (configuration, basePath, axios) {
|
|
|
545
545
|
* @param {*} [options] Override http request option.
|
|
546
546
|
* @throws {RequiredError}
|
|
547
547
|
*/
|
|
548
|
-
|
|
549
|
-
return localVarFp.
|
|
548
|
+
cancel1(id, options) {
|
|
549
|
+
return localVarFp.cancel1(id, options).then((request) => request(axios, basePath));
|
|
550
550
|
},
|
|
551
551
|
/**
|
|
552
552
|
*
|
|
@@ -651,8 +651,8 @@ class ESignApi extends base_1.BaseAPI {
|
|
|
651
651
|
* @param {*} [options] Override http request option.
|
|
652
652
|
* @throws {RequiredError}
|
|
653
653
|
*/
|
|
654
|
-
|
|
655
|
-
return (0, exports.ESignApiFp)(this.configuration).
|
|
654
|
+
cancel1(id, options) {
|
|
655
|
+
return (0, exports.ESignApiFp)(this.configuration).cancel1(id, options).then((request) => request(this.axios, this.basePath));
|
|
656
656
|
}
|
|
657
657
|
/**
|
|
658
658
|
*
|
|
@@ -0,0 +1,565 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* openfilz-api
|
|
3
|
+
* API for Document Management System
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { CancelInstanceRequest } from '../models';
|
|
16
|
+
import type { CompleteTaskRequest } from '../models';
|
|
17
|
+
import type { MyTasksCountDTO } from '../models';
|
|
18
|
+
import type { ReassignTaskRequest } from '../models';
|
|
19
|
+
import type { SaveWorkflowDefinitionRequest } from '../models';
|
|
20
|
+
import type { StartWorkflowRequest } from '../models';
|
|
21
|
+
import type { WorkflowDefinitionDTO } from '../models';
|
|
22
|
+
import type { WorkflowInstanceDTO } from '../models';
|
|
23
|
+
import type { WorkflowInstanceDetailDTO } from '../models';
|
|
24
|
+
import type { WorkflowInstancePage } from '../models';
|
|
25
|
+
import type { WorkflowSummaryDTO } from '../models';
|
|
26
|
+
import type { WorkflowTaskDTO } from '../models';
|
|
27
|
+
import type { WorkflowValidationResult } from '../models';
|
|
28
|
+
/**
|
|
29
|
+
* WorkflowsApi - axios parameter creator
|
|
30
|
+
*/
|
|
31
|
+
export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @summary Cancel a running instance (initiator)
|
|
35
|
+
* @param {string} id
|
|
36
|
+
* @param {CancelInstanceRequest} [cancelInstanceRequest]
|
|
37
|
+
* @param {*} [options] Override http request option.
|
|
38
|
+
* @throws {RequiredError}
|
|
39
|
+
*/
|
|
40
|
+
cancel: (id: string, cancelInstanceRequest?: CancelInstanceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @summary Take a transition on a task I am a candidate of
|
|
44
|
+
* @param {string} id
|
|
45
|
+
* @param {CompleteTaskRequest} completeTaskRequest
|
|
46
|
+
* @param {*} [options] Override http request option.
|
|
47
|
+
* @throws {RequiredError}
|
|
48
|
+
*/
|
|
49
|
+
complete: (id: string, completeTaskRequest: CompleteTaskRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @summary Create a workflow definition (400 with the problem list when invalid)
|
|
53
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
*/
|
|
57
|
+
createDefinition: (saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
|
+
/**
|
|
59
|
+
*
|
|
60
|
+
* @summary Delete a workflow definition (409 while instances are running)
|
|
61
|
+
* @param {string} id
|
|
62
|
+
* @param {*} [options] Override http request option.
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
*/
|
|
65
|
+
deleteDefinition: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
|
+
/**
|
|
67
|
+
*
|
|
68
|
+
* @summary Get a workflow definition
|
|
69
|
+
* @param {string} id
|
|
70
|
+
* @param {*} [options] Override http request option.
|
|
71
|
+
* @throws {RequiredError}
|
|
72
|
+
*/
|
|
73
|
+
getDefinition: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
74
|
+
/**
|
|
75
|
+
*
|
|
76
|
+
* @summary One instance with its snapshot spec, open task and history
|
|
77
|
+
* @param {string} id
|
|
78
|
+
* @param {*} [options] Override http request option.
|
|
79
|
+
* @throws {RequiredError}
|
|
80
|
+
*/
|
|
81
|
+
getInstance: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82
|
+
/**
|
|
83
|
+
*
|
|
84
|
+
* @summary List workflow definitions
|
|
85
|
+
* @param {boolean} [active]
|
|
86
|
+
* @param {*} [options] Override http request option.
|
|
87
|
+
* @throws {RequiredError}
|
|
88
|
+
*/
|
|
89
|
+
listDefinitions: (active?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
90
|
+
/**
|
|
91
|
+
*
|
|
92
|
+
* @summary List instances (monitor), newest first
|
|
93
|
+
* @param {string} [documentId]
|
|
94
|
+
* @param {string} [definitionId]
|
|
95
|
+
* @param {ListInstancesStatusEnum} [status]
|
|
96
|
+
* @param {string} [state]
|
|
97
|
+
* @param {boolean} [mine]
|
|
98
|
+
* @param {number} [page]
|
|
99
|
+
* @param {number} [size]
|
|
100
|
+
* @param {*} [options] Override http request option.
|
|
101
|
+
* @throws {RequiredError}
|
|
102
|
+
*/
|
|
103
|
+
listInstances: (documentId?: string, definitionId?: string, status?: ListInstancesStatusEnum, state?: string, mine?: boolean, page?: number, size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
104
|
+
/**
|
|
105
|
+
*
|
|
106
|
+
* @summary Open tasks I can act on (by e-mail or role)
|
|
107
|
+
* @param {*} [options] Override http request option.
|
|
108
|
+
* @throws {RequiredError}
|
|
109
|
+
*/
|
|
110
|
+
myTasks: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
111
|
+
/**
|
|
112
|
+
*
|
|
113
|
+
* @summary Number of open tasks I can act on (sidebar badge)
|
|
114
|
+
* @param {*} [options] Override http request option.
|
|
115
|
+
* @throws {RequiredError}
|
|
116
|
+
*/
|
|
117
|
+
myTasksCount: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
118
|
+
/**
|
|
119
|
+
*
|
|
120
|
+
* @summary Hand a task to other people (initiator or current candidate)
|
|
121
|
+
* @param {string} id
|
|
122
|
+
* @param {ReassignTaskRequest} reassignTaskRequest
|
|
123
|
+
* @param {*} [options] Override http request option.
|
|
124
|
+
* @throws {RequiredError}
|
|
125
|
+
*/
|
|
126
|
+
reassign: (id: string, reassignTaskRequest: ReassignTaskRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
127
|
+
/**
|
|
128
|
+
*
|
|
129
|
+
* @summary Start a workflow on a document (409 when one is already running)
|
|
130
|
+
* @param {StartWorkflowRequest} startWorkflowRequest
|
|
131
|
+
* @param {string} [acceptLanguage]
|
|
132
|
+
* @param {*} [options] Override http request option.
|
|
133
|
+
* @throws {RequiredError}
|
|
134
|
+
*/
|
|
135
|
+
start: (startWorkflowRequest: StartWorkflowRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
136
|
+
/**
|
|
137
|
+
*
|
|
138
|
+
* @summary Counts for the monitor header
|
|
139
|
+
* @param {*} [options] Override http request option.
|
|
140
|
+
* @throws {RequiredError}
|
|
141
|
+
*/
|
|
142
|
+
summary: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
143
|
+
/**
|
|
144
|
+
*
|
|
145
|
+
* @summary Update a workflow definition (running instances keep their snapshot)
|
|
146
|
+
* @param {string} id
|
|
147
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
updateDefinition: (id: string, saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
152
|
+
/**
|
|
153
|
+
*
|
|
154
|
+
* @summary Validate a definition without saving it
|
|
155
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
156
|
+
* @param {*} [options] Override http request option.
|
|
157
|
+
* @throws {RequiredError}
|
|
158
|
+
*/
|
|
159
|
+
validateDefinition: (saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
160
|
+
};
|
|
161
|
+
/**
|
|
162
|
+
* WorkflowsApi - functional programming interface
|
|
163
|
+
*/
|
|
164
|
+
export declare const WorkflowsApiFp: (configuration?: Configuration) => {
|
|
165
|
+
/**
|
|
166
|
+
*
|
|
167
|
+
* @summary Cancel a running instance (initiator)
|
|
168
|
+
* @param {string} id
|
|
169
|
+
* @param {CancelInstanceRequest} [cancelInstanceRequest]
|
|
170
|
+
* @param {*} [options] Override http request option.
|
|
171
|
+
* @throws {RequiredError}
|
|
172
|
+
*/
|
|
173
|
+
cancel(id: string, cancelInstanceRequest?: CancelInstanceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDTO>>;
|
|
174
|
+
/**
|
|
175
|
+
*
|
|
176
|
+
* @summary Take a transition on a task I am a candidate of
|
|
177
|
+
* @param {string} id
|
|
178
|
+
* @param {CompleteTaskRequest} completeTaskRequest
|
|
179
|
+
* @param {*} [options] Override http request option.
|
|
180
|
+
* @throws {RequiredError}
|
|
181
|
+
*/
|
|
182
|
+
complete(id: string, completeTaskRequest: CompleteTaskRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDTO>>;
|
|
183
|
+
/**
|
|
184
|
+
*
|
|
185
|
+
* @summary Create a workflow definition (400 with the problem list when invalid)
|
|
186
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
187
|
+
* @param {*} [options] Override http request option.
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
createDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowDefinitionDTO>>;
|
|
191
|
+
/**
|
|
192
|
+
*
|
|
193
|
+
* @summary Delete a workflow definition (409 while instances are running)
|
|
194
|
+
* @param {string} id
|
|
195
|
+
* @param {*} [options] Override http request option.
|
|
196
|
+
* @throws {RequiredError}
|
|
197
|
+
*/
|
|
198
|
+
deleteDefinition(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
199
|
+
/**
|
|
200
|
+
*
|
|
201
|
+
* @summary Get a workflow definition
|
|
202
|
+
* @param {string} id
|
|
203
|
+
* @param {*} [options] Override http request option.
|
|
204
|
+
* @throws {RequiredError}
|
|
205
|
+
*/
|
|
206
|
+
getDefinition(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowDefinitionDTO>>;
|
|
207
|
+
/**
|
|
208
|
+
*
|
|
209
|
+
* @summary One instance with its snapshot spec, open task and history
|
|
210
|
+
* @param {string} id
|
|
211
|
+
* @param {*} [options] Override http request option.
|
|
212
|
+
* @throws {RequiredError}
|
|
213
|
+
*/
|
|
214
|
+
getInstance(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDetailDTO>>;
|
|
215
|
+
/**
|
|
216
|
+
*
|
|
217
|
+
* @summary List workflow definitions
|
|
218
|
+
* @param {boolean} [active]
|
|
219
|
+
* @param {*} [options] Override http request option.
|
|
220
|
+
* @throws {RequiredError}
|
|
221
|
+
*/
|
|
222
|
+
listDefinitions(active?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowDefinitionDTO>>>;
|
|
223
|
+
/**
|
|
224
|
+
*
|
|
225
|
+
* @summary List instances (monitor), newest first
|
|
226
|
+
* @param {string} [documentId]
|
|
227
|
+
* @param {string} [definitionId]
|
|
228
|
+
* @param {ListInstancesStatusEnum} [status]
|
|
229
|
+
* @param {string} [state]
|
|
230
|
+
* @param {boolean} [mine]
|
|
231
|
+
* @param {number} [page]
|
|
232
|
+
* @param {number} [size]
|
|
233
|
+
* @param {*} [options] Override http request option.
|
|
234
|
+
* @throws {RequiredError}
|
|
235
|
+
*/
|
|
236
|
+
listInstances(documentId?: string, definitionId?: string, status?: ListInstancesStatusEnum, state?: string, mine?: boolean, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstancePage>>;
|
|
237
|
+
/**
|
|
238
|
+
*
|
|
239
|
+
* @summary Open tasks I can act on (by e-mail or role)
|
|
240
|
+
* @param {*} [options] Override http request option.
|
|
241
|
+
* @throws {RequiredError}
|
|
242
|
+
*/
|
|
243
|
+
myTasks(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowTaskDTO>>>;
|
|
244
|
+
/**
|
|
245
|
+
*
|
|
246
|
+
* @summary Number of open tasks I can act on (sidebar badge)
|
|
247
|
+
* @param {*} [options] Override http request option.
|
|
248
|
+
* @throws {RequiredError}
|
|
249
|
+
*/
|
|
250
|
+
myTasksCount(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MyTasksCountDTO>>;
|
|
251
|
+
/**
|
|
252
|
+
*
|
|
253
|
+
* @summary Hand a task to other people (initiator or current candidate)
|
|
254
|
+
* @param {string} id
|
|
255
|
+
* @param {ReassignTaskRequest} reassignTaskRequest
|
|
256
|
+
* @param {*} [options] Override http request option.
|
|
257
|
+
* @throws {RequiredError}
|
|
258
|
+
*/
|
|
259
|
+
reassign(id: string, reassignTaskRequest: ReassignTaskRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDTO>>;
|
|
260
|
+
/**
|
|
261
|
+
*
|
|
262
|
+
* @summary Start a workflow on a document (409 when one is already running)
|
|
263
|
+
* @param {StartWorkflowRequest} startWorkflowRequest
|
|
264
|
+
* @param {string} [acceptLanguage]
|
|
265
|
+
* @param {*} [options] Override http request option.
|
|
266
|
+
* @throws {RequiredError}
|
|
267
|
+
*/
|
|
268
|
+
start(startWorkflowRequest: StartWorkflowRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDTO>>;
|
|
269
|
+
/**
|
|
270
|
+
*
|
|
271
|
+
* @summary Counts for the monitor header
|
|
272
|
+
* @param {*} [options] Override http request option.
|
|
273
|
+
* @throws {RequiredError}
|
|
274
|
+
*/
|
|
275
|
+
summary(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowSummaryDTO>>;
|
|
276
|
+
/**
|
|
277
|
+
*
|
|
278
|
+
* @summary Update a workflow definition (running instances keep their snapshot)
|
|
279
|
+
* @param {string} id
|
|
280
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
281
|
+
* @param {*} [options] Override http request option.
|
|
282
|
+
* @throws {RequiredError}
|
|
283
|
+
*/
|
|
284
|
+
updateDefinition(id: string, saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowDefinitionDTO>>;
|
|
285
|
+
/**
|
|
286
|
+
*
|
|
287
|
+
* @summary Validate a definition without saving it
|
|
288
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
289
|
+
* @param {*} [options] Override http request option.
|
|
290
|
+
* @throws {RequiredError}
|
|
291
|
+
*/
|
|
292
|
+
validateDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowValidationResult>>;
|
|
293
|
+
};
|
|
294
|
+
/**
|
|
295
|
+
* WorkflowsApi - factory interface
|
|
296
|
+
*/
|
|
297
|
+
export declare const WorkflowsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
298
|
+
/**
|
|
299
|
+
*
|
|
300
|
+
* @summary Cancel a running instance (initiator)
|
|
301
|
+
* @param {string} id
|
|
302
|
+
* @param {CancelInstanceRequest} [cancelInstanceRequest]
|
|
303
|
+
* @param {*} [options] Override http request option.
|
|
304
|
+
* @throws {RequiredError}
|
|
305
|
+
*/
|
|
306
|
+
cancel(id: string, cancelInstanceRequest?: CancelInstanceRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDTO>;
|
|
307
|
+
/**
|
|
308
|
+
*
|
|
309
|
+
* @summary Take a transition on a task I am a candidate of
|
|
310
|
+
* @param {string} id
|
|
311
|
+
* @param {CompleteTaskRequest} completeTaskRequest
|
|
312
|
+
* @param {*} [options] Override http request option.
|
|
313
|
+
* @throws {RequiredError}
|
|
314
|
+
*/
|
|
315
|
+
complete(id: string, completeTaskRequest: CompleteTaskRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDTO>;
|
|
316
|
+
/**
|
|
317
|
+
*
|
|
318
|
+
* @summary Create a workflow definition (400 with the problem list when invalid)
|
|
319
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
320
|
+
* @param {*} [options] Override http request option.
|
|
321
|
+
* @throws {RequiredError}
|
|
322
|
+
*/
|
|
323
|
+
createDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowDefinitionDTO>;
|
|
324
|
+
/**
|
|
325
|
+
*
|
|
326
|
+
* @summary Delete a workflow definition (409 while instances are running)
|
|
327
|
+
* @param {string} id
|
|
328
|
+
* @param {*} [options] Override http request option.
|
|
329
|
+
* @throws {RequiredError}
|
|
330
|
+
*/
|
|
331
|
+
deleteDefinition(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
332
|
+
/**
|
|
333
|
+
*
|
|
334
|
+
* @summary Get a workflow definition
|
|
335
|
+
* @param {string} id
|
|
336
|
+
* @param {*} [options] Override http request option.
|
|
337
|
+
* @throws {RequiredError}
|
|
338
|
+
*/
|
|
339
|
+
getDefinition(id: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowDefinitionDTO>;
|
|
340
|
+
/**
|
|
341
|
+
*
|
|
342
|
+
* @summary One instance with its snapshot spec, open task and history
|
|
343
|
+
* @param {string} id
|
|
344
|
+
* @param {*} [options] Override http request option.
|
|
345
|
+
* @throws {RequiredError}
|
|
346
|
+
*/
|
|
347
|
+
getInstance(id: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDetailDTO>;
|
|
348
|
+
/**
|
|
349
|
+
*
|
|
350
|
+
* @summary List workflow definitions
|
|
351
|
+
* @param {boolean} [active]
|
|
352
|
+
* @param {*} [options] Override http request option.
|
|
353
|
+
* @throws {RequiredError}
|
|
354
|
+
*/
|
|
355
|
+
listDefinitions(active?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowDefinitionDTO>>;
|
|
356
|
+
/**
|
|
357
|
+
*
|
|
358
|
+
* @summary List instances (monitor), newest first
|
|
359
|
+
* @param {string} [documentId]
|
|
360
|
+
* @param {string} [definitionId]
|
|
361
|
+
* @param {ListInstancesStatusEnum} [status]
|
|
362
|
+
* @param {string} [state]
|
|
363
|
+
* @param {boolean} [mine]
|
|
364
|
+
* @param {number} [page]
|
|
365
|
+
* @param {number} [size]
|
|
366
|
+
* @param {*} [options] Override http request option.
|
|
367
|
+
* @throws {RequiredError}
|
|
368
|
+
*/
|
|
369
|
+
listInstances(documentId?: string, definitionId?: string, status?: ListInstancesStatusEnum, state?: string, mine?: boolean, page?: number, size?: number, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstancePage>;
|
|
370
|
+
/**
|
|
371
|
+
*
|
|
372
|
+
* @summary Open tasks I can act on (by e-mail or role)
|
|
373
|
+
* @param {*} [options] Override http request option.
|
|
374
|
+
* @throws {RequiredError}
|
|
375
|
+
*/
|
|
376
|
+
myTasks(options?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowTaskDTO>>;
|
|
377
|
+
/**
|
|
378
|
+
*
|
|
379
|
+
* @summary Number of open tasks I can act on (sidebar badge)
|
|
380
|
+
* @param {*} [options] Override http request option.
|
|
381
|
+
* @throws {RequiredError}
|
|
382
|
+
*/
|
|
383
|
+
myTasksCount(options?: RawAxiosRequestConfig): AxiosPromise<MyTasksCountDTO>;
|
|
384
|
+
/**
|
|
385
|
+
*
|
|
386
|
+
* @summary Hand a task to other people (initiator or current candidate)
|
|
387
|
+
* @param {string} id
|
|
388
|
+
* @param {ReassignTaskRequest} reassignTaskRequest
|
|
389
|
+
* @param {*} [options] Override http request option.
|
|
390
|
+
* @throws {RequiredError}
|
|
391
|
+
*/
|
|
392
|
+
reassign(id: string, reassignTaskRequest: ReassignTaskRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDTO>;
|
|
393
|
+
/**
|
|
394
|
+
*
|
|
395
|
+
* @summary Start a workflow on a document (409 when one is already running)
|
|
396
|
+
* @param {StartWorkflowRequest} startWorkflowRequest
|
|
397
|
+
* @param {string} [acceptLanguage]
|
|
398
|
+
* @param {*} [options] Override http request option.
|
|
399
|
+
* @throws {RequiredError}
|
|
400
|
+
*/
|
|
401
|
+
start(startWorkflowRequest: StartWorkflowRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDTO>;
|
|
402
|
+
/**
|
|
403
|
+
*
|
|
404
|
+
* @summary Counts for the monitor header
|
|
405
|
+
* @param {*} [options] Override http request option.
|
|
406
|
+
* @throws {RequiredError}
|
|
407
|
+
*/
|
|
408
|
+
summary(options?: RawAxiosRequestConfig): AxiosPromise<WorkflowSummaryDTO>;
|
|
409
|
+
/**
|
|
410
|
+
*
|
|
411
|
+
* @summary Update a workflow definition (running instances keep their snapshot)
|
|
412
|
+
* @param {string} id
|
|
413
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
414
|
+
* @param {*} [options] Override http request option.
|
|
415
|
+
* @throws {RequiredError}
|
|
416
|
+
*/
|
|
417
|
+
updateDefinition(id: string, saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowDefinitionDTO>;
|
|
418
|
+
/**
|
|
419
|
+
*
|
|
420
|
+
* @summary Validate a definition without saving it
|
|
421
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
422
|
+
* @param {*} [options] Override http request option.
|
|
423
|
+
* @throws {RequiredError}
|
|
424
|
+
*/
|
|
425
|
+
validateDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowValidationResult>;
|
|
426
|
+
};
|
|
427
|
+
/**
|
|
428
|
+
* WorkflowsApi - object-oriented interface
|
|
429
|
+
*/
|
|
430
|
+
export declare class WorkflowsApi extends BaseAPI {
|
|
431
|
+
/**
|
|
432
|
+
*
|
|
433
|
+
* @summary Cancel a running instance (initiator)
|
|
434
|
+
* @param {string} id
|
|
435
|
+
* @param {CancelInstanceRequest} [cancelInstanceRequest]
|
|
436
|
+
* @param {*} [options] Override http request option.
|
|
437
|
+
* @throws {RequiredError}
|
|
438
|
+
*/
|
|
439
|
+
cancel(id: string, cancelInstanceRequest?: CancelInstanceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowInstanceDTO, any, {}, any>>;
|
|
440
|
+
/**
|
|
441
|
+
*
|
|
442
|
+
* @summary Take a transition on a task I am a candidate of
|
|
443
|
+
* @param {string} id
|
|
444
|
+
* @param {CompleteTaskRequest} completeTaskRequest
|
|
445
|
+
* @param {*} [options] Override http request option.
|
|
446
|
+
* @throws {RequiredError}
|
|
447
|
+
*/
|
|
448
|
+
complete(id: string, completeTaskRequest: CompleteTaskRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowInstanceDTO, any, {}, any>>;
|
|
449
|
+
/**
|
|
450
|
+
*
|
|
451
|
+
* @summary Create a workflow definition (400 with the problem list when invalid)
|
|
452
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
453
|
+
* @param {*} [options] Override http request option.
|
|
454
|
+
* @throws {RequiredError}
|
|
455
|
+
*/
|
|
456
|
+
createDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowDefinitionDTO, any, {}, any>>;
|
|
457
|
+
/**
|
|
458
|
+
*
|
|
459
|
+
* @summary Delete a workflow definition (409 while instances are running)
|
|
460
|
+
* @param {string} id
|
|
461
|
+
* @param {*} [options] Override http request option.
|
|
462
|
+
* @throws {RequiredError}
|
|
463
|
+
*/
|
|
464
|
+
deleteDefinition(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
|
|
465
|
+
/**
|
|
466
|
+
*
|
|
467
|
+
* @summary Get a workflow definition
|
|
468
|
+
* @param {string} id
|
|
469
|
+
* @param {*} [options] Override http request option.
|
|
470
|
+
* @throws {RequiredError}
|
|
471
|
+
*/
|
|
472
|
+
getDefinition(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowDefinitionDTO, any, {}, any>>;
|
|
473
|
+
/**
|
|
474
|
+
*
|
|
475
|
+
* @summary One instance with its snapshot spec, open task and history
|
|
476
|
+
* @param {string} id
|
|
477
|
+
* @param {*} [options] Override http request option.
|
|
478
|
+
* @throws {RequiredError}
|
|
479
|
+
*/
|
|
480
|
+
getInstance(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowInstanceDetailDTO, any, {}, any>>;
|
|
481
|
+
/**
|
|
482
|
+
*
|
|
483
|
+
* @summary List workflow definitions
|
|
484
|
+
* @param {boolean} [active]
|
|
485
|
+
* @param {*} [options] Override http request option.
|
|
486
|
+
* @throws {RequiredError}
|
|
487
|
+
*/
|
|
488
|
+
listDefinitions(active?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowDefinitionDTO[], any, {}, any>>;
|
|
489
|
+
/**
|
|
490
|
+
*
|
|
491
|
+
* @summary List instances (monitor), newest first
|
|
492
|
+
* @param {string} [documentId]
|
|
493
|
+
* @param {string} [definitionId]
|
|
494
|
+
* @param {ListInstancesStatusEnum} [status]
|
|
495
|
+
* @param {string} [state]
|
|
496
|
+
* @param {boolean} [mine]
|
|
497
|
+
* @param {number} [page]
|
|
498
|
+
* @param {number} [size]
|
|
499
|
+
* @param {*} [options] Override http request option.
|
|
500
|
+
* @throws {RequiredError}
|
|
501
|
+
*/
|
|
502
|
+
listInstances(documentId?: string, definitionId?: string, status?: ListInstancesStatusEnum, state?: string, mine?: boolean, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowInstancePage, any, {}, any>>;
|
|
503
|
+
/**
|
|
504
|
+
*
|
|
505
|
+
* @summary Open tasks I can act on (by e-mail or role)
|
|
506
|
+
* @param {*} [options] Override http request option.
|
|
507
|
+
* @throws {RequiredError}
|
|
508
|
+
*/
|
|
509
|
+
myTasks(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowTaskDTO[], any, {}, any>>;
|
|
510
|
+
/**
|
|
511
|
+
*
|
|
512
|
+
* @summary Number of open tasks I can act on (sidebar badge)
|
|
513
|
+
* @param {*} [options] Override http request option.
|
|
514
|
+
* @throws {RequiredError}
|
|
515
|
+
*/
|
|
516
|
+
myTasksCount(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MyTasksCountDTO, any, {}, any>>;
|
|
517
|
+
/**
|
|
518
|
+
*
|
|
519
|
+
* @summary Hand a task to other people (initiator or current candidate)
|
|
520
|
+
* @param {string} id
|
|
521
|
+
* @param {ReassignTaskRequest} reassignTaskRequest
|
|
522
|
+
* @param {*} [options] Override http request option.
|
|
523
|
+
* @throws {RequiredError}
|
|
524
|
+
*/
|
|
525
|
+
reassign(id: string, reassignTaskRequest: ReassignTaskRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowInstanceDTO, any, {}, any>>;
|
|
526
|
+
/**
|
|
527
|
+
*
|
|
528
|
+
* @summary Start a workflow on a document (409 when one is already running)
|
|
529
|
+
* @param {StartWorkflowRequest} startWorkflowRequest
|
|
530
|
+
* @param {string} [acceptLanguage]
|
|
531
|
+
* @param {*} [options] Override http request option.
|
|
532
|
+
* @throws {RequiredError}
|
|
533
|
+
*/
|
|
534
|
+
start(startWorkflowRequest: StartWorkflowRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowInstanceDTO, any, {}, any>>;
|
|
535
|
+
/**
|
|
536
|
+
*
|
|
537
|
+
* @summary Counts for the monitor header
|
|
538
|
+
* @param {*} [options] Override http request option.
|
|
539
|
+
* @throws {RequiredError}
|
|
540
|
+
*/
|
|
541
|
+
summary(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowSummaryDTO, any, {}, any>>;
|
|
542
|
+
/**
|
|
543
|
+
*
|
|
544
|
+
* @summary Update a workflow definition (running instances keep their snapshot)
|
|
545
|
+
* @param {string} id
|
|
546
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
547
|
+
* @param {*} [options] Override http request option.
|
|
548
|
+
* @throws {RequiredError}
|
|
549
|
+
*/
|
|
550
|
+
updateDefinition(id: string, saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowDefinitionDTO, any, {}, any>>;
|
|
551
|
+
/**
|
|
552
|
+
*
|
|
553
|
+
* @summary Validate a definition without saving it
|
|
554
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
555
|
+
* @param {*} [options] Override http request option.
|
|
556
|
+
* @throws {RequiredError}
|
|
557
|
+
*/
|
|
558
|
+
validateDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowValidationResult, any, {}, any>>;
|
|
559
|
+
}
|
|
560
|
+
export declare const ListInstancesStatusEnum: {
|
|
561
|
+
readonly Running: "RUNNING";
|
|
562
|
+
readonly Completed: "COMPLETED";
|
|
563
|
+
readonly Cancelled: "CANCELLED";
|
|
564
|
+
};
|
|
565
|
+
export type ListInstancesStatusEnum = typeof ListInstancesStatusEnum[keyof typeof ListInstancesStatusEnum];
|