@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
|
@@ -0,0 +1,1234 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* openfilz-api
|
|
5
|
+
* API for Document Management System
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import type { Configuration } from '../configuration';
|
|
17
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
18
|
+
import globalAxios from 'axios';
|
|
19
|
+
// Some imports not used depending on template conditions
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
|
|
22
|
+
// @ts-ignore
|
|
23
|
+
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
24
|
+
// @ts-ignore
|
|
25
|
+
import type { CancelInstanceRequest } from '../models';
|
|
26
|
+
// @ts-ignore
|
|
27
|
+
import type { CompleteTaskRequest } from '../models';
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
import type { MyTasksCountDTO } from '../models';
|
|
30
|
+
// @ts-ignore
|
|
31
|
+
import type { ReassignTaskRequest } from '../models';
|
|
32
|
+
// @ts-ignore
|
|
33
|
+
import type { SaveWorkflowDefinitionRequest } from '../models';
|
|
34
|
+
// @ts-ignore
|
|
35
|
+
import type { StartWorkflowRequest } from '../models';
|
|
36
|
+
// @ts-ignore
|
|
37
|
+
import type { WorkflowDefinitionDTO } from '../models';
|
|
38
|
+
// @ts-ignore
|
|
39
|
+
import type { WorkflowInstanceDTO } from '../models';
|
|
40
|
+
// @ts-ignore
|
|
41
|
+
import type { WorkflowInstanceDetailDTO } from '../models';
|
|
42
|
+
// @ts-ignore
|
|
43
|
+
import type { WorkflowInstancePage } from '../models';
|
|
44
|
+
// @ts-ignore
|
|
45
|
+
import type { WorkflowSummaryDTO } from '../models';
|
|
46
|
+
// @ts-ignore
|
|
47
|
+
import type { WorkflowTaskDTO } from '../models';
|
|
48
|
+
// @ts-ignore
|
|
49
|
+
import type { WorkflowValidationResult } from '../models';
|
|
50
|
+
/**
|
|
51
|
+
* WorkflowsApi - axios parameter creator
|
|
52
|
+
*/
|
|
53
|
+
export const WorkflowsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
54
|
+
return {
|
|
55
|
+
/**
|
|
56
|
+
*
|
|
57
|
+
* @summary Cancel a running instance (initiator)
|
|
58
|
+
* @param {string} id
|
|
59
|
+
* @param {CancelInstanceRequest} [cancelInstanceRequest]
|
|
60
|
+
* @param {*} [options] Override http request option.
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
*/
|
|
63
|
+
cancel: async (id: string, cancelInstanceRequest?: CancelInstanceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
64
|
+
// verify required parameter 'id' is not null or undefined
|
|
65
|
+
assertParamExists('cancel', 'id', id)
|
|
66
|
+
const localVarPath = `/api/v1/workflows/instances/{id}/cancel`
|
|
67
|
+
.replace('{id}', encodeURIComponent(String(id)));
|
|
68
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
69
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
70
|
+
let baseOptions;
|
|
71
|
+
if (configuration) {
|
|
72
|
+
baseOptions = configuration.baseOptions;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
76
|
+
const localVarHeaderParameter = {} as any;
|
|
77
|
+
const localVarQueryParameter = {} as any;
|
|
78
|
+
|
|
79
|
+
// authentication keycloak_auth required
|
|
80
|
+
// http bearer authentication required
|
|
81
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
82
|
+
|
|
83
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
84
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
85
|
+
|
|
86
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
87
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
88
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
89
|
+
localVarRequestOptions.data = serializeDataIfNeeded(cancelInstanceRequest, localVarRequestOptions, configuration)
|
|
90
|
+
|
|
91
|
+
return {
|
|
92
|
+
url: toPathString(localVarUrlObj),
|
|
93
|
+
options: localVarRequestOptions,
|
|
94
|
+
};
|
|
95
|
+
},
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @summary Take a transition on a task I am a candidate of
|
|
99
|
+
* @param {string} id
|
|
100
|
+
* @param {CompleteTaskRequest} completeTaskRequest
|
|
101
|
+
* @param {*} [options] Override http request option.
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
*/
|
|
104
|
+
complete: async (id: string, completeTaskRequest: CompleteTaskRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
105
|
+
// verify required parameter 'id' is not null or undefined
|
|
106
|
+
assertParamExists('complete', 'id', id)
|
|
107
|
+
// verify required parameter 'completeTaskRequest' is not null or undefined
|
|
108
|
+
assertParamExists('complete', 'completeTaskRequest', completeTaskRequest)
|
|
109
|
+
const localVarPath = `/api/v1/workflows/tasks/{id}/complete`
|
|
110
|
+
.replace('{id}', encodeURIComponent(String(id)));
|
|
111
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
112
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
113
|
+
let baseOptions;
|
|
114
|
+
if (configuration) {
|
|
115
|
+
baseOptions = configuration.baseOptions;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
119
|
+
const localVarHeaderParameter = {} as any;
|
|
120
|
+
const localVarQueryParameter = {} as any;
|
|
121
|
+
|
|
122
|
+
// authentication keycloak_auth required
|
|
123
|
+
// http bearer authentication required
|
|
124
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
125
|
+
|
|
126
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
127
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
128
|
+
|
|
129
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
130
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
131
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
132
|
+
localVarRequestOptions.data = serializeDataIfNeeded(completeTaskRequest, localVarRequestOptions, configuration)
|
|
133
|
+
|
|
134
|
+
return {
|
|
135
|
+
url: toPathString(localVarUrlObj),
|
|
136
|
+
options: localVarRequestOptions,
|
|
137
|
+
};
|
|
138
|
+
},
|
|
139
|
+
/**
|
|
140
|
+
*
|
|
141
|
+
* @summary Create a workflow definition (400 with the problem list when invalid)
|
|
142
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
143
|
+
* @param {*} [options] Override http request option.
|
|
144
|
+
* @throws {RequiredError}
|
|
145
|
+
*/
|
|
146
|
+
createDefinition: async (saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
147
|
+
// verify required parameter 'saveWorkflowDefinitionRequest' is not null or undefined
|
|
148
|
+
assertParamExists('createDefinition', 'saveWorkflowDefinitionRequest', saveWorkflowDefinitionRequest)
|
|
149
|
+
const localVarPath = `/api/v1/workflows/definitions`;
|
|
150
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
151
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
152
|
+
let baseOptions;
|
|
153
|
+
if (configuration) {
|
|
154
|
+
baseOptions = configuration.baseOptions;
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
158
|
+
const localVarHeaderParameter = {} as any;
|
|
159
|
+
const localVarQueryParameter = {} as any;
|
|
160
|
+
|
|
161
|
+
// authentication keycloak_auth required
|
|
162
|
+
// http bearer authentication required
|
|
163
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
164
|
+
|
|
165
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
166
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
167
|
+
|
|
168
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
169
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
170
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
171
|
+
localVarRequestOptions.data = serializeDataIfNeeded(saveWorkflowDefinitionRequest, localVarRequestOptions, configuration)
|
|
172
|
+
|
|
173
|
+
return {
|
|
174
|
+
url: toPathString(localVarUrlObj),
|
|
175
|
+
options: localVarRequestOptions,
|
|
176
|
+
};
|
|
177
|
+
},
|
|
178
|
+
/**
|
|
179
|
+
*
|
|
180
|
+
* @summary Delete a workflow definition (409 while instances are running)
|
|
181
|
+
* @param {string} id
|
|
182
|
+
* @param {*} [options] Override http request option.
|
|
183
|
+
* @throws {RequiredError}
|
|
184
|
+
*/
|
|
185
|
+
deleteDefinition: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
186
|
+
// verify required parameter 'id' is not null or undefined
|
|
187
|
+
assertParamExists('deleteDefinition', 'id', id)
|
|
188
|
+
const localVarPath = `/api/v1/workflows/definitions/{id}`
|
|
189
|
+
.replace('{id}', encodeURIComponent(String(id)));
|
|
190
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
191
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
192
|
+
let baseOptions;
|
|
193
|
+
if (configuration) {
|
|
194
|
+
baseOptions = configuration.baseOptions;
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
198
|
+
const localVarHeaderParameter = {} as any;
|
|
199
|
+
const localVarQueryParameter = {} as any;
|
|
200
|
+
|
|
201
|
+
// authentication keycloak_auth required
|
|
202
|
+
// http bearer authentication required
|
|
203
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
207
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
208
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
209
|
+
|
|
210
|
+
return {
|
|
211
|
+
url: toPathString(localVarUrlObj),
|
|
212
|
+
options: localVarRequestOptions,
|
|
213
|
+
};
|
|
214
|
+
},
|
|
215
|
+
/**
|
|
216
|
+
*
|
|
217
|
+
* @summary Get a workflow definition
|
|
218
|
+
* @param {string} id
|
|
219
|
+
* @param {*} [options] Override http request option.
|
|
220
|
+
* @throws {RequiredError}
|
|
221
|
+
*/
|
|
222
|
+
getDefinition: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
223
|
+
// verify required parameter 'id' is not null or undefined
|
|
224
|
+
assertParamExists('getDefinition', 'id', id)
|
|
225
|
+
const localVarPath = `/api/v1/workflows/definitions/{id}`
|
|
226
|
+
.replace('{id}', encodeURIComponent(String(id)));
|
|
227
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
228
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
229
|
+
let baseOptions;
|
|
230
|
+
if (configuration) {
|
|
231
|
+
baseOptions = configuration.baseOptions;
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
235
|
+
const localVarHeaderParameter = {} as any;
|
|
236
|
+
const localVarQueryParameter = {} as any;
|
|
237
|
+
|
|
238
|
+
// authentication keycloak_auth required
|
|
239
|
+
// http bearer authentication required
|
|
240
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
241
|
+
|
|
242
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
243
|
+
|
|
244
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
245
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
246
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
247
|
+
|
|
248
|
+
return {
|
|
249
|
+
url: toPathString(localVarUrlObj),
|
|
250
|
+
options: localVarRequestOptions,
|
|
251
|
+
};
|
|
252
|
+
},
|
|
253
|
+
/**
|
|
254
|
+
*
|
|
255
|
+
* @summary One instance with its snapshot spec, open task and history
|
|
256
|
+
* @param {string} id
|
|
257
|
+
* @param {*} [options] Override http request option.
|
|
258
|
+
* @throws {RequiredError}
|
|
259
|
+
*/
|
|
260
|
+
getInstance: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
261
|
+
// verify required parameter 'id' is not null or undefined
|
|
262
|
+
assertParamExists('getInstance', 'id', id)
|
|
263
|
+
const localVarPath = `/api/v1/workflows/instances/{id}`
|
|
264
|
+
.replace('{id}', encodeURIComponent(String(id)));
|
|
265
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
266
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
267
|
+
let baseOptions;
|
|
268
|
+
if (configuration) {
|
|
269
|
+
baseOptions = configuration.baseOptions;
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
273
|
+
const localVarHeaderParameter = {} as any;
|
|
274
|
+
const localVarQueryParameter = {} as any;
|
|
275
|
+
|
|
276
|
+
// authentication keycloak_auth required
|
|
277
|
+
// http bearer authentication required
|
|
278
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
279
|
+
|
|
280
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
281
|
+
|
|
282
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
283
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
284
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
285
|
+
|
|
286
|
+
return {
|
|
287
|
+
url: toPathString(localVarUrlObj),
|
|
288
|
+
options: localVarRequestOptions,
|
|
289
|
+
};
|
|
290
|
+
},
|
|
291
|
+
/**
|
|
292
|
+
*
|
|
293
|
+
* @summary List workflow definitions
|
|
294
|
+
* @param {boolean} [active]
|
|
295
|
+
* @param {*} [options] Override http request option.
|
|
296
|
+
* @throws {RequiredError}
|
|
297
|
+
*/
|
|
298
|
+
listDefinitions: async (active?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
299
|
+
const localVarPath = `/api/v1/workflows/definitions`;
|
|
300
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
301
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
302
|
+
let baseOptions;
|
|
303
|
+
if (configuration) {
|
|
304
|
+
baseOptions = configuration.baseOptions;
|
|
305
|
+
}
|
|
306
|
+
|
|
307
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
308
|
+
const localVarHeaderParameter = {} as any;
|
|
309
|
+
const localVarQueryParameter = {} as any;
|
|
310
|
+
|
|
311
|
+
// authentication keycloak_auth required
|
|
312
|
+
// http bearer authentication required
|
|
313
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
314
|
+
|
|
315
|
+
if (active !== undefined) {
|
|
316
|
+
localVarQueryParameter['active'] = active;
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
320
|
+
|
|
321
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
322
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
323
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
324
|
+
|
|
325
|
+
return {
|
|
326
|
+
url: toPathString(localVarUrlObj),
|
|
327
|
+
options: localVarRequestOptions,
|
|
328
|
+
};
|
|
329
|
+
},
|
|
330
|
+
/**
|
|
331
|
+
*
|
|
332
|
+
* @summary List instances (monitor), newest first
|
|
333
|
+
* @param {string} [documentId]
|
|
334
|
+
* @param {string} [definitionId]
|
|
335
|
+
* @param {ListInstancesStatusEnum} [status]
|
|
336
|
+
* @param {string} [state]
|
|
337
|
+
* @param {boolean} [mine]
|
|
338
|
+
* @param {number} [page]
|
|
339
|
+
* @param {number} [size]
|
|
340
|
+
* @param {*} [options] Override http request option.
|
|
341
|
+
* @throws {RequiredError}
|
|
342
|
+
*/
|
|
343
|
+
listInstances: async (documentId?: string, definitionId?: string, status?: ListInstancesStatusEnum, state?: string, mine?: boolean, page?: number, size?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
344
|
+
const localVarPath = `/api/v1/workflows/instances`;
|
|
345
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
346
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
347
|
+
let baseOptions;
|
|
348
|
+
if (configuration) {
|
|
349
|
+
baseOptions = configuration.baseOptions;
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
353
|
+
const localVarHeaderParameter = {} as any;
|
|
354
|
+
const localVarQueryParameter = {} as any;
|
|
355
|
+
|
|
356
|
+
// authentication keycloak_auth required
|
|
357
|
+
// http bearer authentication required
|
|
358
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
359
|
+
|
|
360
|
+
if (documentId !== undefined) {
|
|
361
|
+
localVarQueryParameter['documentId'] = documentId;
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
if (definitionId !== undefined) {
|
|
365
|
+
localVarQueryParameter['definitionId'] = definitionId;
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
if (status !== undefined) {
|
|
369
|
+
localVarQueryParameter['status'] = status;
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
if (state !== undefined) {
|
|
373
|
+
localVarQueryParameter['state'] = state;
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
if (mine !== undefined) {
|
|
377
|
+
localVarQueryParameter['mine'] = mine;
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
if (page !== undefined) {
|
|
381
|
+
localVarQueryParameter['page'] = page;
|
|
382
|
+
}
|
|
383
|
+
|
|
384
|
+
if (size !== undefined) {
|
|
385
|
+
localVarQueryParameter['size'] = size;
|
|
386
|
+
}
|
|
387
|
+
|
|
388
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
389
|
+
|
|
390
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
391
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
392
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
393
|
+
|
|
394
|
+
return {
|
|
395
|
+
url: toPathString(localVarUrlObj),
|
|
396
|
+
options: localVarRequestOptions,
|
|
397
|
+
};
|
|
398
|
+
},
|
|
399
|
+
/**
|
|
400
|
+
*
|
|
401
|
+
* @summary Open tasks I can act on (by e-mail or role)
|
|
402
|
+
* @param {*} [options] Override http request option.
|
|
403
|
+
* @throws {RequiredError}
|
|
404
|
+
*/
|
|
405
|
+
myTasks: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
406
|
+
const localVarPath = `/api/v1/workflows/tasks/mine`;
|
|
407
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
408
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
409
|
+
let baseOptions;
|
|
410
|
+
if (configuration) {
|
|
411
|
+
baseOptions = configuration.baseOptions;
|
|
412
|
+
}
|
|
413
|
+
|
|
414
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
415
|
+
const localVarHeaderParameter = {} as any;
|
|
416
|
+
const localVarQueryParameter = {} as any;
|
|
417
|
+
|
|
418
|
+
// authentication keycloak_auth required
|
|
419
|
+
// http bearer authentication required
|
|
420
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
421
|
+
|
|
422
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
423
|
+
|
|
424
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
425
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
426
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
427
|
+
|
|
428
|
+
return {
|
|
429
|
+
url: toPathString(localVarUrlObj),
|
|
430
|
+
options: localVarRequestOptions,
|
|
431
|
+
};
|
|
432
|
+
},
|
|
433
|
+
/**
|
|
434
|
+
*
|
|
435
|
+
* @summary Number of open tasks I can act on (sidebar badge)
|
|
436
|
+
* @param {*} [options] Override http request option.
|
|
437
|
+
* @throws {RequiredError}
|
|
438
|
+
*/
|
|
439
|
+
myTasksCount: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
440
|
+
const localVarPath = `/api/v1/workflows/tasks/mine/count`;
|
|
441
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
442
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
443
|
+
let baseOptions;
|
|
444
|
+
if (configuration) {
|
|
445
|
+
baseOptions = configuration.baseOptions;
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
449
|
+
const localVarHeaderParameter = {} as any;
|
|
450
|
+
const localVarQueryParameter = {} as any;
|
|
451
|
+
|
|
452
|
+
// authentication keycloak_auth required
|
|
453
|
+
// http bearer authentication required
|
|
454
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
455
|
+
|
|
456
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
457
|
+
|
|
458
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
459
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
460
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
461
|
+
|
|
462
|
+
return {
|
|
463
|
+
url: toPathString(localVarUrlObj),
|
|
464
|
+
options: localVarRequestOptions,
|
|
465
|
+
};
|
|
466
|
+
},
|
|
467
|
+
/**
|
|
468
|
+
*
|
|
469
|
+
* @summary Hand a task to other people (initiator or current candidate)
|
|
470
|
+
* @param {string} id
|
|
471
|
+
* @param {ReassignTaskRequest} reassignTaskRequest
|
|
472
|
+
* @param {*} [options] Override http request option.
|
|
473
|
+
* @throws {RequiredError}
|
|
474
|
+
*/
|
|
475
|
+
reassign: async (id: string, reassignTaskRequest: ReassignTaskRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
476
|
+
// verify required parameter 'id' is not null or undefined
|
|
477
|
+
assertParamExists('reassign', 'id', id)
|
|
478
|
+
// verify required parameter 'reassignTaskRequest' is not null or undefined
|
|
479
|
+
assertParamExists('reassign', 'reassignTaskRequest', reassignTaskRequest)
|
|
480
|
+
const localVarPath = `/api/v1/workflows/tasks/{id}/reassign`
|
|
481
|
+
.replace('{id}', encodeURIComponent(String(id)));
|
|
482
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
483
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
484
|
+
let baseOptions;
|
|
485
|
+
if (configuration) {
|
|
486
|
+
baseOptions = configuration.baseOptions;
|
|
487
|
+
}
|
|
488
|
+
|
|
489
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
490
|
+
const localVarHeaderParameter = {} as any;
|
|
491
|
+
const localVarQueryParameter = {} as any;
|
|
492
|
+
|
|
493
|
+
// authentication keycloak_auth required
|
|
494
|
+
// http bearer authentication required
|
|
495
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
496
|
+
|
|
497
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
498
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
499
|
+
|
|
500
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
501
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
502
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
503
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reassignTaskRequest, localVarRequestOptions, configuration)
|
|
504
|
+
|
|
505
|
+
return {
|
|
506
|
+
url: toPathString(localVarUrlObj),
|
|
507
|
+
options: localVarRequestOptions,
|
|
508
|
+
};
|
|
509
|
+
},
|
|
510
|
+
/**
|
|
511
|
+
*
|
|
512
|
+
* @summary Start a workflow on a document (409 when one is already running)
|
|
513
|
+
* @param {StartWorkflowRequest} startWorkflowRequest
|
|
514
|
+
* @param {string} [acceptLanguage]
|
|
515
|
+
* @param {*} [options] Override http request option.
|
|
516
|
+
* @throws {RequiredError}
|
|
517
|
+
*/
|
|
518
|
+
start: async (startWorkflowRequest: StartWorkflowRequest, acceptLanguage?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
519
|
+
// verify required parameter 'startWorkflowRequest' is not null or undefined
|
|
520
|
+
assertParamExists('start', 'startWorkflowRequest', startWorkflowRequest)
|
|
521
|
+
const localVarPath = `/api/v1/workflows/instances`;
|
|
522
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
523
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
524
|
+
let baseOptions;
|
|
525
|
+
if (configuration) {
|
|
526
|
+
baseOptions = configuration.baseOptions;
|
|
527
|
+
}
|
|
528
|
+
|
|
529
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
530
|
+
const localVarHeaderParameter = {} as any;
|
|
531
|
+
const localVarQueryParameter = {} as any;
|
|
532
|
+
|
|
533
|
+
// authentication keycloak_auth required
|
|
534
|
+
// http bearer authentication required
|
|
535
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
536
|
+
|
|
537
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
538
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
539
|
+
|
|
540
|
+
if (acceptLanguage != null) {
|
|
541
|
+
localVarHeaderParameter['Accept-Language'] = String(acceptLanguage);
|
|
542
|
+
}
|
|
543
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
544
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
545
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
546
|
+
localVarRequestOptions.data = serializeDataIfNeeded(startWorkflowRequest, localVarRequestOptions, configuration)
|
|
547
|
+
|
|
548
|
+
return {
|
|
549
|
+
url: toPathString(localVarUrlObj),
|
|
550
|
+
options: localVarRequestOptions,
|
|
551
|
+
};
|
|
552
|
+
},
|
|
553
|
+
/**
|
|
554
|
+
*
|
|
555
|
+
* @summary Counts for the monitor header
|
|
556
|
+
* @param {*} [options] Override http request option.
|
|
557
|
+
* @throws {RequiredError}
|
|
558
|
+
*/
|
|
559
|
+
summary: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
560
|
+
const localVarPath = `/api/v1/workflows/instances/summary`;
|
|
561
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
562
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
563
|
+
let baseOptions;
|
|
564
|
+
if (configuration) {
|
|
565
|
+
baseOptions = configuration.baseOptions;
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
569
|
+
const localVarHeaderParameter = {} as any;
|
|
570
|
+
const localVarQueryParameter = {} as any;
|
|
571
|
+
|
|
572
|
+
// authentication keycloak_auth required
|
|
573
|
+
// http bearer authentication required
|
|
574
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
575
|
+
|
|
576
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
577
|
+
|
|
578
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
579
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
580
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
581
|
+
|
|
582
|
+
return {
|
|
583
|
+
url: toPathString(localVarUrlObj),
|
|
584
|
+
options: localVarRequestOptions,
|
|
585
|
+
};
|
|
586
|
+
},
|
|
587
|
+
/**
|
|
588
|
+
*
|
|
589
|
+
* @summary Update a workflow definition (running instances keep their snapshot)
|
|
590
|
+
* @param {string} id
|
|
591
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
592
|
+
* @param {*} [options] Override http request option.
|
|
593
|
+
* @throws {RequiredError}
|
|
594
|
+
*/
|
|
595
|
+
updateDefinition: async (id: string, saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
596
|
+
// verify required parameter 'id' is not null or undefined
|
|
597
|
+
assertParamExists('updateDefinition', 'id', id)
|
|
598
|
+
// verify required parameter 'saveWorkflowDefinitionRequest' is not null or undefined
|
|
599
|
+
assertParamExists('updateDefinition', 'saveWorkflowDefinitionRequest', saveWorkflowDefinitionRequest)
|
|
600
|
+
const localVarPath = `/api/v1/workflows/definitions/{id}`
|
|
601
|
+
.replace('{id}', encodeURIComponent(String(id)));
|
|
602
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
603
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
604
|
+
let baseOptions;
|
|
605
|
+
if (configuration) {
|
|
606
|
+
baseOptions = configuration.baseOptions;
|
|
607
|
+
}
|
|
608
|
+
|
|
609
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
610
|
+
const localVarHeaderParameter = {} as any;
|
|
611
|
+
const localVarQueryParameter = {} as any;
|
|
612
|
+
|
|
613
|
+
// authentication keycloak_auth required
|
|
614
|
+
// http bearer authentication required
|
|
615
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
616
|
+
|
|
617
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
618
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
619
|
+
|
|
620
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
621
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
622
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
623
|
+
localVarRequestOptions.data = serializeDataIfNeeded(saveWorkflowDefinitionRequest, localVarRequestOptions, configuration)
|
|
624
|
+
|
|
625
|
+
return {
|
|
626
|
+
url: toPathString(localVarUrlObj),
|
|
627
|
+
options: localVarRequestOptions,
|
|
628
|
+
};
|
|
629
|
+
},
|
|
630
|
+
/**
|
|
631
|
+
*
|
|
632
|
+
* @summary Validate a definition without saving it
|
|
633
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
634
|
+
* @param {*} [options] Override http request option.
|
|
635
|
+
* @throws {RequiredError}
|
|
636
|
+
*/
|
|
637
|
+
validateDefinition: async (saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
638
|
+
// verify required parameter 'saveWorkflowDefinitionRequest' is not null or undefined
|
|
639
|
+
assertParamExists('validateDefinition', 'saveWorkflowDefinitionRequest', saveWorkflowDefinitionRequest)
|
|
640
|
+
const localVarPath = `/api/v1/workflows/definitions/validate`;
|
|
641
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
642
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
643
|
+
let baseOptions;
|
|
644
|
+
if (configuration) {
|
|
645
|
+
baseOptions = configuration.baseOptions;
|
|
646
|
+
}
|
|
647
|
+
|
|
648
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
649
|
+
const localVarHeaderParameter = {} as any;
|
|
650
|
+
const localVarQueryParameter = {} as any;
|
|
651
|
+
|
|
652
|
+
// authentication keycloak_auth required
|
|
653
|
+
// http bearer authentication required
|
|
654
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
655
|
+
|
|
656
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
657
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
658
|
+
|
|
659
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
660
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
661
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
662
|
+
localVarRequestOptions.data = serializeDataIfNeeded(saveWorkflowDefinitionRequest, localVarRequestOptions, configuration)
|
|
663
|
+
|
|
664
|
+
return {
|
|
665
|
+
url: toPathString(localVarUrlObj),
|
|
666
|
+
options: localVarRequestOptions,
|
|
667
|
+
};
|
|
668
|
+
},
|
|
669
|
+
}
|
|
670
|
+
};
|
|
671
|
+
|
|
672
|
+
/**
|
|
673
|
+
* WorkflowsApi - functional programming interface
|
|
674
|
+
*/
|
|
675
|
+
export const WorkflowsApiFp = function(configuration?: Configuration) {
|
|
676
|
+
const localVarAxiosParamCreator = WorkflowsApiAxiosParamCreator(configuration)
|
|
677
|
+
return {
|
|
678
|
+
/**
|
|
679
|
+
*
|
|
680
|
+
* @summary Cancel a running instance (initiator)
|
|
681
|
+
* @param {string} id
|
|
682
|
+
* @param {CancelInstanceRequest} [cancelInstanceRequest]
|
|
683
|
+
* @param {*} [options] Override http request option.
|
|
684
|
+
* @throws {RequiredError}
|
|
685
|
+
*/
|
|
686
|
+
async cancel(id: string, cancelInstanceRequest?: CancelInstanceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDTO>> {
|
|
687
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.cancel(id, cancelInstanceRequest, options);
|
|
688
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
689
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.cancel']?.[localVarOperationServerIndex]?.url;
|
|
690
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
691
|
+
},
|
|
692
|
+
/**
|
|
693
|
+
*
|
|
694
|
+
* @summary Take a transition on a task I am a candidate of
|
|
695
|
+
* @param {string} id
|
|
696
|
+
* @param {CompleteTaskRequest} completeTaskRequest
|
|
697
|
+
* @param {*} [options] Override http request option.
|
|
698
|
+
* @throws {RequiredError}
|
|
699
|
+
*/
|
|
700
|
+
async complete(id: string, completeTaskRequest: CompleteTaskRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDTO>> {
|
|
701
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.complete(id, completeTaskRequest, options);
|
|
702
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
703
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.complete']?.[localVarOperationServerIndex]?.url;
|
|
704
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
705
|
+
},
|
|
706
|
+
/**
|
|
707
|
+
*
|
|
708
|
+
* @summary Create a workflow definition (400 with the problem list when invalid)
|
|
709
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
710
|
+
* @param {*} [options] Override http request option.
|
|
711
|
+
* @throws {RequiredError}
|
|
712
|
+
*/
|
|
713
|
+
async createDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowDefinitionDTO>> {
|
|
714
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createDefinition(saveWorkflowDefinitionRequest, options);
|
|
715
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
716
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.createDefinition']?.[localVarOperationServerIndex]?.url;
|
|
717
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
718
|
+
},
|
|
719
|
+
/**
|
|
720
|
+
*
|
|
721
|
+
* @summary Delete a workflow definition (409 while instances are running)
|
|
722
|
+
* @param {string} id
|
|
723
|
+
* @param {*} [options] Override http request option.
|
|
724
|
+
* @throws {RequiredError}
|
|
725
|
+
*/
|
|
726
|
+
async deleteDefinition(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
727
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDefinition(id, options);
|
|
728
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
729
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.deleteDefinition']?.[localVarOperationServerIndex]?.url;
|
|
730
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
731
|
+
},
|
|
732
|
+
/**
|
|
733
|
+
*
|
|
734
|
+
* @summary Get a workflow definition
|
|
735
|
+
* @param {string} id
|
|
736
|
+
* @param {*} [options] Override http request option.
|
|
737
|
+
* @throws {RequiredError}
|
|
738
|
+
*/
|
|
739
|
+
async getDefinition(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowDefinitionDTO>> {
|
|
740
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDefinition(id, options);
|
|
741
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
742
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.getDefinition']?.[localVarOperationServerIndex]?.url;
|
|
743
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
744
|
+
},
|
|
745
|
+
/**
|
|
746
|
+
*
|
|
747
|
+
* @summary One instance with its snapshot spec, open task and history
|
|
748
|
+
* @param {string} id
|
|
749
|
+
* @param {*} [options] Override http request option.
|
|
750
|
+
* @throws {RequiredError}
|
|
751
|
+
*/
|
|
752
|
+
async getInstance(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDetailDTO>> {
|
|
753
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getInstance(id, options);
|
|
754
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
755
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.getInstance']?.[localVarOperationServerIndex]?.url;
|
|
756
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
757
|
+
},
|
|
758
|
+
/**
|
|
759
|
+
*
|
|
760
|
+
* @summary List workflow definitions
|
|
761
|
+
* @param {boolean} [active]
|
|
762
|
+
* @param {*} [options] Override http request option.
|
|
763
|
+
* @throws {RequiredError}
|
|
764
|
+
*/
|
|
765
|
+
async listDefinitions(active?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowDefinitionDTO>>> {
|
|
766
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDefinitions(active, options);
|
|
767
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
768
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.listDefinitions']?.[localVarOperationServerIndex]?.url;
|
|
769
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
770
|
+
},
|
|
771
|
+
/**
|
|
772
|
+
*
|
|
773
|
+
* @summary List instances (monitor), newest first
|
|
774
|
+
* @param {string} [documentId]
|
|
775
|
+
* @param {string} [definitionId]
|
|
776
|
+
* @param {ListInstancesStatusEnum} [status]
|
|
777
|
+
* @param {string} [state]
|
|
778
|
+
* @param {boolean} [mine]
|
|
779
|
+
* @param {number} [page]
|
|
780
|
+
* @param {number} [size]
|
|
781
|
+
* @param {*} [options] Override http request option.
|
|
782
|
+
* @throws {RequiredError}
|
|
783
|
+
*/
|
|
784
|
+
async listInstances(documentId?: string, definitionId?: string, status?: ListInstancesStatusEnum, state?: string, mine?: boolean, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstancePage>> {
|
|
785
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listInstances(documentId, definitionId, status, state, mine, page, size, options);
|
|
786
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
787
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.listInstances']?.[localVarOperationServerIndex]?.url;
|
|
788
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
789
|
+
},
|
|
790
|
+
/**
|
|
791
|
+
*
|
|
792
|
+
* @summary Open tasks I can act on (by e-mail or role)
|
|
793
|
+
* @param {*} [options] Override http request option.
|
|
794
|
+
* @throws {RequiredError}
|
|
795
|
+
*/
|
|
796
|
+
async myTasks(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowTaskDTO>>> {
|
|
797
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.myTasks(options);
|
|
798
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
799
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.myTasks']?.[localVarOperationServerIndex]?.url;
|
|
800
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
801
|
+
},
|
|
802
|
+
/**
|
|
803
|
+
*
|
|
804
|
+
* @summary Number of open tasks I can act on (sidebar badge)
|
|
805
|
+
* @param {*} [options] Override http request option.
|
|
806
|
+
* @throws {RequiredError}
|
|
807
|
+
*/
|
|
808
|
+
async myTasksCount(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MyTasksCountDTO>> {
|
|
809
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.myTasksCount(options);
|
|
810
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
811
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.myTasksCount']?.[localVarOperationServerIndex]?.url;
|
|
812
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
813
|
+
},
|
|
814
|
+
/**
|
|
815
|
+
*
|
|
816
|
+
* @summary Hand a task to other people (initiator or current candidate)
|
|
817
|
+
* @param {string} id
|
|
818
|
+
* @param {ReassignTaskRequest} reassignTaskRequest
|
|
819
|
+
* @param {*} [options] Override http request option.
|
|
820
|
+
* @throws {RequiredError}
|
|
821
|
+
*/
|
|
822
|
+
async reassign(id: string, reassignTaskRequest: ReassignTaskRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDTO>> {
|
|
823
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.reassign(id, reassignTaskRequest, options);
|
|
824
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
825
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.reassign']?.[localVarOperationServerIndex]?.url;
|
|
826
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
827
|
+
},
|
|
828
|
+
/**
|
|
829
|
+
*
|
|
830
|
+
* @summary Start a workflow on a document (409 when one is already running)
|
|
831
|
+
* @param {StartWorkflowRequest} startWorkflowRequest
|
|
832
|
+
* @param {string} [acceptLanguage]
|
|
833
|
+
* @param {*} [options] Override http request option.
|
|
834
|
+
* @throws {RequiredError}
|
|
835
|
+
*/
|
|
836
|
+
async start(startWorkflowRequest: StartWorkflowRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDTO>> {
|
|
837
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.start(startWorkflowRequest, acceptLanguage, options);
|
|
838
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
839
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.start']?.[localVarOperationServerIndex]?.url;
|
|
840
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
841
|
+
},
|
|
842
|
+
/**
|
|
843
|
+
*
|
|
844
|
+
* @summary Counts for the monitor header
|
|
845
|
+
* @param {*} [options] Override http request option.
|
|
846
|
+
* @throws {RequiredError}
|
|
847
|
+
*/
|
|
848
|
+
async summary(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowSummaryDTO>> {
|
|
849
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.summary(options);
|
|
850
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
851
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.summary']?.[localVarOperationServerIndex]?.url;
|
|
852
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
853
|
+
},
|
|
854
|
+
/**
|
|
855
|
+
*
|
|
856
|
+
* @summary Update a workflow definition (running instances keep their snapshot)
|
|
857
|
+
* @param {string} id
|
|
858
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
859
|
+
* @param {*} [options] Override http request option.
|
|
860
|
+
* @throws {RequiredError}
|
|
861
|
+
*/
|
|
862
|
+
async updateDefinition(id: string, saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowDefinitionDTO>> {
|
|
863
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateDefinition(id, saveWorkflowDefinitionRequest, options);
|
|
864
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
865
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.updateDefinition']?.[localVarOperationServerIndex]?.url;
|
|
866
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
867
|
+
},
|
|
868
|
+
/**
|
|
869
|
+
*
|
|
870
|
+
* @summary Validate a definition without saving it
|
|
871
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
872
|
+
* @param {*} [options] Override http request option.
|
|
873
|
+
* @throws {RequiredError}
|
|
874
|
+
*/
|
|
875
|
+
async validateDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowValidationResult>> {
|
|
876
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.validateDefinition(saveWorkflowDefinitionRequest, options);
|
|
877
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
878
|
+
const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.validateDefinition']?.[localVarOperationServerIndex]?.url;
|
|
879
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
880
|
+
},
|
|
881
|
+
}
|
|
882
|
+
};
|
|
883
|
+
|
|
884
|
+
/**
|
|
885
|
+
* WorkflowsApi - factory interface
|
|
886
|
+
*/
|
|
887
|
+
export const WorkflowsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
888
|
+
const localVarFp = WorkflowsApiFp(configuration)
|
|
889
|
+
return {
|
|
890
|
+
/**
|
|
891
|
+
*
|
|
892
|
+
* @summary Cancel a running instance (initiator)
|
|
893
|
+
* @param {string} id
|
|
894
|
+
* @param {CancelInstanceRequest} [cancelInstanceRequest]
|
|
895
|
+
* @param {*} [options] Override http request option.
|
|
896
|
+
* @throws {RequiredError}
|
|
897
|
+
*/
|
|
898
|
+
cancel(id: string, cancelInstanceRequest?: CancelInstanceRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDTO> {
|
|
899
|
+
return localVarFp.cancel(id, cancelInstanceRequest, options).then((request) => request(axios, basePath));
|
|
900
|
+
},
|
|
901
|
+
/**
|
|
902
|
+
*
|
|
903
|
+
* @summary Take a transition on a task I am a candidate of
|
|
904
|
+
* @param {string} id
|
|
905
|
+
* @param {CompleteTaskRequest} completeTaskRequest
|
|
906
|
+
* @param {*} [options] Override http request option.
|
|
907
|
+
* @throws {RequiredError}
|
|
908
|
+
*/
|
|
909
|
+
complete(id: string, completeTaskRequest: CompleteTaskRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDTO> {
|
|
910
|
+
return localVarFp.complete(id, completeTaskRequest, options).then((request) => request(axios, basePath));
|
|
911
|
+
},
|
|
912
|
+
/**
|
|
913
|
+
*
|
|
914
|
+
* @summary Create a workflow definition (400 with the problem list when invalid)
|
|
915
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
916
|
+
* @param {*} [options] Override http request option.
|
|
917
|
+
* @throws {RequiredError}
|
|
918
|
+
*/
|
|
919
|
+
createDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowDefinitionDTO> {
|
|
920
|
+
return localVarFp.createDefinition(saveWorkflowDefinitionRequest, options).then((request) => request(axios, basePath));
|
|
921
|
+
},
|
|
922
|
+
/**
|
|
923
|
+
*
|
|
924
|
+
* @summary Delete a workflow definition (409 while instances are running)
|
|
925
|
+
* @param {string} id
|
|
926
|
+
* @param {*} [options] Override http request option.
|
|
927
|
+
* @throws {RequiredError}
|
|
928
|
+
*/
|
|
929
|
+
deleteDefinition(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
930
|
+
return localVarFp.deleteDefinition(id, options).then((request) => request(axios, basePath));
|
|
931
|
+
},
|
|
932
|
+
/**
|
|
933
|
+
*
|
|
934
|
+
* @summary Get a workflow definition
|
|
935
|
+
* @param {string} id
|
|
936
|
+
* @param {*} [options] Override http request option.
|
|
937
|
+
* @throws {RequiredError}
|
|
938
|
+
*/
|
|
939
|
+
getDefinition(id: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowDefinitionDTO> {
|
|
940
|
+
return localVarFp.getDefinition(id, options).then((request) => request(axios, basePath));
|
|
941
|
+
},
|
|
942
|
+
/**
|
|
943
|
+
*
|
|
944
|
+
* @summary One instance with its snapshot spec, open task and history
|
|
945
|
+
* @param {string} id
|
|
946
|
+
* @param {*} [options] Override http request option.
|
|
947
|
+
* @throws {RequiredError}
|
|
948
|
+
*/
|
|
949
|
+
getInstance(id: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDetailDTO> {
|
|
950
|
+
return localVarFp.getInstance(id, options).then((request) => request(axios, basePath));
|
|
951
|
+
},
|
|
952
|
+
/**
|
|
953
|
+
*
|
|
954
|
+
* @summary List workflow definitions
|
|
955
|
+
* @param {boolean} [active]
|
|
956
|
+
* @param {*} [options] Override http request option.
|
|
957
|
+
* @throws {RequiredError}
|
|
958
|
+
*/
|
|
959
|
+
listDefinitions(active?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowDefinitionDTO>> {
|
|
960
|
+
return localVarFp.listDefinitions(active, options).then((request) => request(axios, basePath));
|
|
961
|
+
},
|
|
962
|
+
/**
|
|
963
|
+
*
|
|
964
|
+
* @summary List instances (monitor), newest first
|
|
965
|
+
* @param {string} [documentId]
|
|
966
|
+
* @param {string} [definitionId]
|
|
967
|
+
* @param {ListInstancesStatusEnum} [status]
|
|
968
|
+
* @param {string} [state]
|
|
969
|
+
* @param {boolean} [mine]
|
|
970
|
+
* @param {number} [page]
|
|
971
|
+
* @param {number} [size]
|
|
972
|
+
* @param {*} [options] Override http request option.
|
|
973
|
+
* @throws {RequiredError}
|
|
974
|
+
*/
|
|
975
|
+
listInstances(documentId?: string, definitionId?: string, status?: ListInstancesStatusEnum, state?: string, mine?: boolean, page?: number, size?: number, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstancePage> {
|
|
976
|
+
return localVarFp.listInstances(documentId, definitionId, status, state, mine, page, size, options).then((request) => request(axios, basePath));
|
|
977
|
+
},
|
|
978
|
+
/**
|
|
979
|
+
*
|
|
980
|
+
* @summary Open tasks I can act on (by e-mail or role)
|
|
981
|
+
* @param {*} [options] Override http request option.
|
|
982
|
+
* @throws {RequiredError}
|
|
983
|
+
*/
|
|
984
|
+
myTasks(options?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowTaskDTO>> {
|
|
985
|
+
return localVarFp.myTasks(options).then((request) => request(axios, basePath));
|
|
986
|
+
},
|
|
987
|
+
/**
|
|
988
|
+
*
|
|
989
|
+
* @summary Number of open tasks I can act on (sidebar badge)
|
|
990
|
+
* @param {*} [options] Override http request option.
|
|
991
|
+
* @throws {RequiredError}
|
|
992
|
+
*/
|
|
993
|
+
myTasksCount(options?: RawAxiosRequestConfig): AxiosPromise<MyTasksCountDTO> {
|
|
994
|
+
return localVarFp.myTasksCount(options).then((request) => request(axios, basePath));
|
|
995
|
+
},
|
|
996
|
+
/**
|
|
997
|
+
*
|
|
998
|
+
* @summary Hand a task to other people (initiator or current candidate)
|
|
999
|
+
* @param {string} id
|
|
1000
|
+
* @param {ReassignTaskRequest} reassignTaskRequest
|
|
1001
|
+
* @param {*} [options] Override http request option.
|
|
1002
|
+
* @throws {RequiredError}
|
|
1003
|
+
*/
|
|
1004
|
+
reassign(id: string, reassignTaskRequest: ReassignTaskRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDTO> {
|
|
1005
|
+
return localVarFp.reassign(id, reassignTaskRequest, options).then((request) => request(axios, basePath));
|
|
1006
|
+
},
|
|
1007
|
+
/**
|
|
1008
|
+
*
|
|
1009
|
+
* @summary Start a workflow on a document (409 when one is already running)
|
|
1010
|
+
* @param {StartWorkflowRequest} startWorkflowRequest
|
|
1011
|
+
* @param {string} [acceptLanguage]
|
|
1012
|
+
* @param {*} [options] Override http request option.
|
|
1013
|
+
* @throws {RequiredError}
|
|
1014
|
+
*/
|
|
1015
|
+
start(startWorkflowRequest: StartWorkflowRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDTO> {
|
|
1016
|
+
return localVarFp.start(startWorkflowRequest, acceptLanguage, options).then((request) => request(axios, basePath));
|
|
1017
|
+
},
|
|
1018
|
+
/**
|
|
1019
|
+
*
|
|
1020
|
+
* @summary Counts for the monitor header
|
|
1021
|
+
* @param {*} [options] Override http request option.
|
|
1022
|
+
* @throws {RequiredError}
|
|
1023
|
+
*/
|
|
1024
|
+
summary(options?: RawAxiosRequestConfig): AxiosPromise<WorkflowSummaryDTO> {
|
|
1025
|
+
return localVarFp.summary(options).then((request) => request(axios, basePath));
|
|
1026
|
+
},
|
|
1027
|
+
/**
|
|
1028
|
+
*
|
|
1029
|
+
* @summary Update a workflow definition (running instances keep their snapshot)
|
|
1030
|
+
* @param {string} id
|
|
1031
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
1032
|
+
* @param {*} [options] Override http request option.
|
|
1033
|
+
* @throws {RequiredError}
|
|
1034
|
+
*/
|
|
1035
|
+
updateDefinition(id: string, saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowDefinitionDTO> {
|
|
1036
|
+
return localVarFp.updateDefinition(id, saveWorkflowDefinitionRequest, options).then((request) => request(axios, basePath));
|
|
1037
|
+
},
|
|
1038
|
+
/**
|
|
1039
|
+
*
|
|
1040
|
+
* @summary Validate a definition without saving it
|
|
1041
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
1042
|
+
* @param {*} [options] Override http request option.
|
|
1043
|
+
* @throws {RequiredError}
|
|
1044
|
+
*/
|
|
1045
|
+
validateDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowValidationResult> {
|
|
1046
|
+
return localVarFp.validateDefinition(saveWorkflowDefinitionRequest, options).then((request) => request(axios, basePath));
|
|
1047
|
+
},
|
|
1048
|
+
};
|
|
1049
|
+
};
|
|
1050
|
+
|
|
1051
|
+
/**
|
|
1052
|
+
* WorkflowsApi - object-oriented interface
|
|
1053
|
+
*/
|
|
1054
|
+
export class WorkflowsApi extends BaseAPI {
|
|
1055
|
+
/**
|
|
1056
|
+
*
|
|
1057
|
+
* @summary Cancel a running instance (initiator)
|
|
1058
|
+
* @param {string} id
|
|
1059
|
+
* @param {CancelInstanceRequest} [cancelInstanceRequest]
|
|
1060
|
+
* @param {*} [options] Override http request option.
|
|
1061
|
+
* @throws {RequiredError}
|
|
1062
|
+
*/
|
|
1063
|
+
public cancel(id: string, cancelInstanceRequest?: CancelInstanceRequest, options?: RawAxiosRequestConfig) {
|
|
1064
|
+
return WorkflowsApiFp(this.configuration).cancel(id, cancelInstanceRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1065
|
+
}
|
|
1066
|
+
|
|
1067
|
+
/**
|
|
1068
|
+
*
|
|
1069
|
+
* @summary Take a transition on a task I am a candidate of
|
|
1070
|
+
* @param {string} id
|
|
1071
|
+
* @param {CompleteTaskRequest} completeTaskRequest
|
|
1072
|
+
* @param {*} [options] Override http request option.
|
|
1073
|
+
* @throws {RequiredError}
|
|
1074
|
+
*/
|
|
1075
|
+
public complete(id: string, completeTaskRequest: CompleteTaskRequest, options?: RawAxiosRequestConfig) {
|
|
1076
|
+
return WorkflowsApiFp(this.configuration).complete(id, completeTaskRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1077
|
+
}
|
|
1078
|
+
|
|
1079
|
+
/**
|
|
1080
|
+
*
|
|
1081
|
+
* @summary Create a workflow definition (400 with the problem list when invalid)
|
|
1082
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
1083
|
+
* @param {*} [options] Override http request option.
|
|
1084
|
+
* @throws {RequiredError}
|
|
1085
|
+
*/
|
|
1086
|
+
public createDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig) {
|
|
1087
|
+
return WorkflowsApiFp(this.configuration).createDefinition(saveWorkflowDefinitionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1088
|
+
}
|
|
1089
|
+
|
|
1090
|
+
/**
|
|
1091
|
+
*
|
|
1092
|
+
* @summary Delete a workflow definition (409 while instances are running)
|
|
1093
|
+
* @param {string} id
|
|
1094
|
+
* @param {*} [options] Override http request option.
|
|
1095
|
+
* @throws {RequiredError}
|
|
1096
|
+
*/
|
|
1097
|
+
public deleteDefinition(id: string, options?: RawAxiosRequestConfig) {
|
|
1098
|
+
return WorkflowsApiFp(this.configuration).deleteDefinition(id, options).then((request) => request(this.axios, this.basePath));
|
|
1099
|
+
}
|
|
1100
|
+
|
|
1101
|
+
/**
|
|
1102
|
+
*
|
|
1103
|
+
* @summary Get a workflow definition
|
|
1104
|
+
* @param {string} id
|
|
1105
|
+
* @param {*} [options] Override http request option.
|
|
1106
|
+
* @throws {RequiredError}
|
|
1107
|
+
*/
|
|
1108
|
+
public getDefinition(id: string, options?: RawAxiosRequestConfig) {
|
|
1109
|
+
return WorkflowsApiFp(this.configuration).getDefinition(id, options).then((request) => request(this.axios, this.basePath));
|
|
1110
|
+
}
|
|
1111
|
+
|
|
1112
|
+
/**
|
|
1113
|
+
*
|
|
1114
|
+
* @summary One instance with its snapshot spec, open task and history
|
|
1115
|
+
* @param {string} id
|
|
1116
|
+
* @param {*} [options] Override http request option.
|
|
1117
|
+
* @throws {RequiredError}
|
|
1118
|
+
*/
|
|
1119
|
+
public getInstance(id: string, options?: RawAxiosRequestConfig) {
|
|
1120
|
+
return WorkflowsApiFp(this.configuration).getInstance(id, options).then((request) => request(this.axios, this.basePath));
|
|
1121
|
+
}
|
|
1122
|
+
|
|
1123
|
+
/**
|
|
1124
|
+
*
|
|
1125
|
+
* @summary List workflow definitions
|
|
1126
|
+
* @param {boolean} [active]
|
|
1127
|
+
* @param {*} [options] Override http request option.
|
|
1128
|
+
* @throws {RequiredError}
|
|
1129
|
+
*/
|
|
1130
|
+
public listDefinitions(active?: boolean, options?: RawAxiosRequestConfig) {
|
|
1131
|
+
return WorkflowsApiFp(this.configuration).listDefinitions(active, options).then((request) => request(this.axios, this.basePath));
|
|
1132
|
+
}
|
|
1133
|
+
|
|
1134
|
+
/**
|
|
1135
|
+
*
|
|
1136
|
+
* @summary List instances (monitor), newest first
|
|
1137
|
+
* @param {string} [documentId]
|
|
1138
|
+
* @param {string} [definitionId]
|
|
1139
|
+
* @param {ListInstancesStatusEnum} [status]
|
|
1140
|
+
* @param {string} [state]
|
|
1141
|
+
* @param {boolean} [mine]
|
|
1142
|
+
* @param {number} [page]
|
|
1143
|
+
* @param {number} [size]
|
|
1144
|
+
* @param {*} [options] Override http request option.
|
|
1145
|
+
* @throws {RequiredError}
|
|
1146
|
+
*/
|
|
1147
|
+
public listInstances(documentId?: string, definitionId?: string, status?: ListInstancesStatusEnum, state?: string, mine?: boolean, page?: number, size?: number, options?: RawAxiosRequestConfig) {
|
|
1148
|
+
return WorkflowsApiFp(this.configuration).listInstances(documentId, definitionId, status, state, mine, page, size, options).then((request) => request(this.axios, this.basePath));
|
|
1149
|
+
}
|
|
1150
|
+
|
|
1151
|
+
/**
|
|
1152
|
+
*
|
|
1153
|
+
* @summary Open tasks I can act on (by e-mail or role)
|
|
1154
|
+
* @param {*} [options] Override http request option.
|
|
1155
|
+
* @throws {RequiredError}
|
|
1156
|
+
*/
|
|
1157
|
+
public myTasks(options?: RawAxiosRequestConfig) {
|
|
1158
|
+
return WorkflowsApiFp(this.configuration).myTasks(options).then((request) => request(this.axios, this.basePath));
|
|
1159
|
+
}
|
|
1160
|
+
|
|
1161
|
+
/**
|
|
1162
|
+
*
|
|
1163
|
+
* @summary Number of open tasks I can act on (sidebar badge)
|
|
1164
|
+
* @param {*} [options] Override http request option.
|
|
1165
|
+
* @throws {RequiredError}
|
|
1166
|
+
*/
|
|
1167
|
+
public myTasksCount(options?: RawAxiosRequestConfig) {
|
|
1168
|
+
return WorkflowsApiFp(this.configuration).myTasksCount(options).then((request) => request(this.axios, this.basePath));
|
|
1169
|
+
}
|
|
1170
|
+
|
|
1171
|
+
/**
|
|
1172
|
+
*
|
|
1173
|
+
* @summary Hand a task to other people (initiator or current candidate)
|
|
1174
|
+
* @param {string} id
|
|
1175
|
+
* @param {ReassignTaskRequest} reassignTaskRequest
|
|
1176
|
+
* @param {*} [options] Override http request option.
|
|
1177
|
+
* @throws {RequiredError}
|
|
1178
|
+
*/
|
|
1179
|
+
public reassign(id: string, reassignTaskRequest: ReassignTaskRequest, options?: RawAxiosRequestConfig) {
|
|
1180
|
+
return WorkflowsApiFp(this.configuration).reassign(id, reassignTaskRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1181
|
+
}
|
|
1182
|
+
|
|
1183
|
+
/**
|
|
1184
|
+
*
|
|
1185
|
+
* @summary Start a workflow on a document (409 when one is already running)
|
|
1186
|
+
* @param {StartWorkflowRequest} startWorkflowRequest
|
|
1187
|
+
* @param {string} [acceptLanguage]
|
|
1188
|
+
* @param {*} [options] Override http request option.
|
|
1189
|
+
* @throws {RequiredError}
|
|
1190
|
+
*/
|
|
1191
|
+
public start(startWorkflowRequest: StartWorkflowRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig) {
|
|
1192
|
+
return WorkflowsApiFp(this.configuration).start(startWorkflowRequest, acceptLanguage, options).then((request) => request(this.axios, this.basePath));
|
|
1193
|
+
}
|
|
1194
|
+
|
|
1195
|
+
/**
|
|
1196
|
+
*
|
|
1197
|
+
* @summary Counts for the monitor header
|
|
1198
|
+
* @param {*} [options] Override http request option.
|
|
1199
|
+
* @throws {RequiredError}
|
|
1200
|
+
*/
|
|
1201
|
+
public summary(options?: RawAxiosRequestConfig) {
|
|
1202
|
+
return WorkflowsApiFp(this.configuration).summary(options).then((request) => request(this.axios, this.basePath));
|
|
1203
|
+
}
|
|
1204
|
+
|
|
1205
|
+
/**
|
|
1206
|
+
*
|
|
1207
|
+
* @summary Update a workflow definition (running instances keep their snapshot)
|
|
1208
|
+
* @param {string} id
|
|
1209
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
1210
|
+
* @param {*} [options] Override http request option.
|
|
1211
|
+
* @throws {RequiredError}
|
|
1212
|
+
*/
|
|
1213
|
+
public updateDefinition(id: string, saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig) {
|
|
1214
|
+
return WorkflowsApiFp(this.configuration).updateDefinition(id, saveWorkflowDefinitionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1215
|
+
}
|
|
1216
|
+
|
|
1217
|
+
/**
|
|
1218
|
+
*
|
|
1219
|
+
* @summary Validate a definition without saving it
|
|
1220
|
+
* @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
|
|
1221
|
+
* @param {*} [options] Override http request option.
|
|
1222
|
+
* @throws {RequiredError}
|
|
1223
|
+
*/
|
|
1224
|
+
public validateDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig) {
|
|
1225
|
+
return WorkflowsApiFp(this.configuration).validateDefinition(saveWorkflowDefinitionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1226
|
+
}
|
|
1227
|
+
}
|
|
1228
|
+
|
|
1229
|
+
export const ListInstancesStatusEnum = {
|
|
1230
|
+
Running: 'RUNNING',
|
|
1231
|
+
Completed: 'COMPLETED',
|
|
1232
|
+
Cancelled: 'CANCELLED',
|
|
1233
|
+
} as const;
|
|
1234
|
+
export type ListInstancesStatusEnum = typeof ListInstancesStatusEnum[keyof typeof ListInstancesStatusEnum];
|