@knowledge-stack/ksapi 1.57.0 → 1.59.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +12 -2
- package/README.md +16 -6
- package/dist/apis/FoldersApi.d.ts +63 -4
- package/dist/apis/FoldersApi.js +64 -3
- package/dist/apis/PathPartsApi.d.ts +45 -1
- package/dist/apis/PathPartsApi.js +44 -0
- package/dist/apis/SectionsApi.d.ts +44 -0
- package/dist/apis/SectionsApi.js +43 -0
- package/dist/apis/WorkflowsApi.d.ts +144 -59
- package/dist/apis/WorkflowsApi.js +131 -49
- package/dist/esm/apis/FoldersApi.d.ts +63 -4
- package/dist/esm/apis/FoldersApi.js +64 -3
- package/dist/esm/apis/PathPartsApi.d.ts +45 -1
- package/dist/esm/apis/PathPartsApi.js +45 -1
- package/dist/esm/apis/SectionsApi.d.ts +44 -0
- package/dist/esm/apis/SectionsApi.js +43 -0
- package/dist/esm/apis/WorkflowsApi.d.ts +144 -59
- package/dist/esm/apis/WorkflowsApi.js +132 -50
- package/dist/esm/models/AncestryResponse.d.ts +48 -0
- package/dist/esm/models/AncestryResponse.js +45 -0
- package/dist/esm/models/PathPartAncestorItem.d.ts +96 -0
- package/dist/esm/models/PathPartAncestorItem.js +77 -0
- package/dist/esm/models/SearchSortOrder.d.ts +26 -0
- package/dist/esm/models/SearchSortOrder.js +44 -0
- package/dist/esm/models/SearchablePartType.d.ts +25 -0
- package/dist/esm/models/SearchablePartType.js +43 -0
- package/dist/esm/models/TemporalWorkflowStatusResponse.d.ts +83 -0
- package/dist/esm/models/TemporalWorkflowStatusResponse.js +66 -0
- package/dist/esm/models/WorkflowActionResponse.d.ts +1 -1
- package/dist/esm/models/WorkflowCancelResponse.d.ts +53 -0
- package/dist/esm/models/WorkflowCancelResponse.js +48 -0
- package/dist/esm/models/index.d.ts +6 -1
- package/dist/esm/models/index.js +6 -1
- package/dist/models/AncestryResponse.d.ts +48 -0
- package/dist/models/AncestryResponse.js +53 -0
- package/dist/models/PathPartAncestorItem.d.ts +96 -0
- package/dist/models/PathPartAncestorItem.js +85 -0
- package/dist/models/SearchSortOrder.d.ts +26 -0
- package/dist/models/SearchSortOrder.js +52 -0
- package/dist/models/SearchablePartType.d.ts +25 -0
- package/dist/models/SearchablePartType.js +51 -0
- package/dist/models/TemporalWorkflowStatusResponse.d.ts +83 -0
- package/dist/models/TemporalWorkflowStatusResponse.js +74 -0
- package/dist/models/WorkflowActionResponse.d.ts +1 -1
- package/dist/models/WorkflowCancelResponse.d.ts +53 -0
- package/dist/models/WorkflowCancelResponse.js +56 -0
- package/dist/models/index.d.ts +6 -1
- package/dist/models/index.js +6 -1
- package/docs/AncestryResponse.md +35 -0
- package/docs/FoldersApi.md +94 -4
- package/docs/PathPartAncestorItem.md +51 -0
- package/docs/PathPartsApi.md +75 -0
- package/docs/{WorkflowAction.md → SearchSortOrder.md} +5 -5
- package/docs/SearchablePartType.md +33 -0
- package/docs/SectionsApi.md +75 -0
- package/docs/TemporalWorkflowStatusResponse.md +47 -0
- package/docs/WorkflowActionResponse.md +1 -1
- package/docs/WorkflowCancelResponse.md +37 -0
- package/docs/WorkflowsApi.md +183 -36
- package/package.json +1 -1
- package/src/apis/FoldersApi.ts +136 -7
- package/src/apis/PathPartsApi.ts +88 -0
- package/src/apis/SectionsApi.ts +81 -0
- package/src/apis/WorkflowsApi.ts +249 -90
- package/src/models/AncestryResponse.ts +91 -0
- package/src/models/PathPartAncestorItem.ts +165 -0
- package/src/models/SearchSortOrder.ts +54 -0
- package/src/models/SearchablePartType.ts +53 -0
- package/src/models/TemporalWorkflowStatusResponse.ts +136 -0
- package/src/models/WorkflowActionResponse.ts +1 -1
- package/src/models/WorkflowCancelResponse.ts +92 -0
- package/src/models/index.ts +6 -1
- package/dist/esm/models/WorkflowAction.d.ts +0 -25
- package/dist/esm/models/WorkflowAction.js +0 -43
- package/dist/models/WorkflowAction.d.ts +0 -25
- package/dist/models/WorkflowAction.js +0 -51
- package/src/models/WorkflowAction.ts +0 -53
|
@@ -10,21 +10,30 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { PaginatedResponseWorkflowSummaryResponse,
|
|
14
|
-
export interface
|
|
13
|
+
import type { PaginatedResponseWorkflowSummaryResponse, TemporalWorkflowStatusResponse, WorkflowActionResponse, WorkflowCancelResponse, WorkflowDetailResponse } from '../models/index';
|
|
14
|
+
export interface CancelTemporalWorkflowRequest {
|
|
15
15
|
workflowId: string;
|
|
16
16
|
authorization?: string | null;
|
|
17
17
|
ksUat?: string | null;
|
|
18
18
|
}
|
|
19
|
-
export interface
|
|
20
|
-
|
|
21
|
-
offset?: number;
|
|
19
|
+
export interface DvWorkflowRerunRequest {
|
|
20
|
+
workflowId: string;
|
|
22
21
|
authorization?: string | null;
|
|
23
22
|
ksUat?: string | null;
|
|
24
23
|
}
|
|
25
|
-
export interface
|
|
24
|
+
export interface GetDvWorkflowRequest {
|
|
26
25
|
workflowId: string;
|
|
27
|
-
|
|
26
|
+
authorization?: string | null;
|
|
27
|
+
ksUat?: string | null;
|
|
28
|
+
}
|
|
29
|
+
export interface GetTemporalWorkflowStatusRequest {
|
|
30
|
+
workflowId: string;
|
|
31
|
+
authorization?: string | null;
|
|
32
|
+
ksUat?: string | null;
|
|
33
|
+
}
|
|
34
|
+
export interface ListDvWorkflowsRequest {
|
|
35
|
+
limit?: number;
|
|
36
|
+
offset?: number;
|
|
28
37
|
authorization?: string | null;
|
|
29
38
|
ksUat?: string | null;
|
|
30
39
|
}
|
|
@@ -36,17 +45,17 @@ export interface WorkflowActionRequest {
|
|
|
36
45
|
*/
|
|
37
46
|
export interface WorkflowsApiInterface {
|
|
38
47
|
/**
|
|
39
|
-
* Creates request options for
|
|
48
|
+
* Creates request options for cancelTemporalWorkflow without sending the request
|
|
40
49
|
* @param {string} workflowId
|
|
41
50
|
* @param {string} [authorization]
|
|
42
51
|
* @param {string} [ksUat]
|
|
43
52
|
* @throws {RequiredError}
|
|
44
53
|
* @memberof WorkflowsApiInterface
|
|
45
54
|
*/
|
|
46
|
-
|
|
55
|
+
cancelTemporalWorkflowRequestOpts(requestParameters: CancelTemporalWorkflowRequest): Promise<runtime.RequestOpts>;
|
|
47
56
|
/**
|
|
48
|
-
*
|
|
49
|
-
* @summary
|
|
57
|
+
* Cancel any Temporal workflow owned by the caller\'s tenant. No status guard — this is a thin Temporal wrapper. Cancelling an already-terminal workflow is a no-op on the Temporal side.
|
|
58
|
+
* @summary Cancel Temporal Workflow Handler
|
|
50
59
|
* @param {string} workflowId
|
|
51
60
|
* @param {string} [authorization]
|
|
52
61
|
* @param {string} [ksUat]
|
|
@@ -54,111 +63,187 @@ export interface WorkflowsApiInterface {
|
|
|
54
63
|
* @throws {RequiredError}
|
|
55
64
|
* @memberof WorkflowsApiInterface
|
|
56
65
|
*/
|
|
57
|
-
|
|
66
|
+
cancelTemporalWorkflowRaw(requestParameters: CancelTemporalWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowCancelResponse>>;
|
|
58
67
|
/**
|
|
59
|
-
*
|
|
60
|
-
*
|
|
68
|
+
* Cancel any Temporal workflow owned by the caller\'s tenant. No status guard — this is a thin Temporal wrapper. Cancelling an already-terminal workflow is a no-op on the Temporal side.
|
|
69
|
+
* Cancel Temporal Workflow Handler
|
|
61
70
|
*/
|
|
62
|
-
|
|
71
|
+
cancelTemporalWorkflow(requestParameters: CancelTemporalWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowCancelResponse>;
|
|
63
72
|
/**
|
|
64
|
-
* Creates request options for
|
|
65
|
-
* @param {
|
|
66
|
-
* @param {number} [offset] Number of items to skip
|
|
73
|
+
* Creates request options for dvWorkflowRerun without sending the request
|
|
74
|
+
* @param {string} workflowId
|
|
67
75
|
* @param {string} [authorization]
|
|
68
76
|
* @param {string} [ksUat]
|
|
69
77
|
* @throws {RequiredError}
|
|
70
78
|
* @memberof WorkflowsApiInterface
|
|
71
79
|
*/
|
|
72
|
-
|
|
80
|
+
dvWorkflowRerunRequestOpts(requestParameters: DvWorkflowRerunRequest): Promise<runtime.RequestOpts>;
|
|
73
81
|
/**
|
|
74
|
-
*
|
|
75
|
-
* @summary
|
|
76
|
-
* @param {
|
|
77
|
-
* @param {
|
|
82
|
+
* Rerun a workflow. USER role requires ``can_write`` on the document path.
|
|
83
|
+
* @summary Dv Workflow Rerun Handler
|
|
84
|
+
* @param {string} workflowId
|
|
85
|
+
* @param {string} [authorization]
|
|
86
|
+
* @param {string} [ksUat]
|
|
87
|
+
* @param {*} [options] Override http request option.
|
|
88
|
+
* @throws {RequiredError}
|
|
89
|
+
* @memberof WorkflowsApiInterface
|
|
90
|
+
*/
|
|
91
|
+
dvWorkflowRerunRaw(requestParameters: DvWorkflowRerunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
|
|
92
|
+
/**
|
|
93
|
+
* Rerun a workflow. USER role requires ``can_write`` on the document path.
|
|
94
|
+
* Dv Workflow Rerun Handler
|
|
95
|
+
*/
|
|
96
|
+
dvWorkflowRerun(requestParameters: DvWorkflowRerunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
|
|
97
|
+
/**
|
|
98
|
+
* Creates request options for getDvWorkflow without sending the request
|
|
99
|
+
* @param {string} workflowId
|
|
100
|
+
* @param {string} [authorization]
|
|
101
|
+
* @param {string} [ksUat]
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
* @memberof WorkflowsApiInterface
|
|
104
|
+
*/
|
|
105
|
+
getDvWorkflowRequestOpts(requestParameters: GetDvWorkflowRequest): Promise<runtime.RequestOpts>;
|
|
106
|
+
/**
|
|
107
|
+
* Get single workflow detail with live Temporal status.
|
|
108
|
+
* @summary Get Dv Workflow Handler
|
|
109
|
+
* @param {string} workflowId
|
|
78
110
|
* @param {string} [authorization]
|
|
79
111
|
* @param {string} [ksUat]
|
|
80
112
|
* @param {*} [options] Override http request option.
|
|
81
113
|
* @throws {RequiredError}
|
|
82
114
|
* @memberof WorkflowsApiInterface
|
|
83
115
|
*/
|
|
84
|
-
|
|
116
|
+
getDvWorkflowRaw(requestParameters: GetDvWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
|
|
85
117
|
/**
|
|
86
|
-
*
|
|
87
|
-
*
|
|
118
|
+
* Get single workflow detail with live Temporal status.
|
|
119
|
+
* Get Dv Workflow Handler
|
|
88
120
|
*/
|
|
89
|
-
|
|
121
|
+
getDvWorkflow(requestParameters: GetDvWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
|
|
90
122
|
/**
|
|
91
|
-
* Creates request options for
|
|
123
|
+
* Creates request options for getTemporalWorkflowStatus without sending the request
|
|
92
124
|
* @param {string} workflowId
|
|
93
|
-
* @param {WorkflowAction} action Action to perform
|
|
94
125
|
* @param {string} [authorization]
|
|
95
126
|
* @param {string} [ksUat]
|
|
96
127
|
* @throws {RequiredError}
|
|
97
128
|
* @memberof WorkflowsApiInterface
|
|
98
129
|
*/
|
|
99
|
-
|
|
130
|
+
getTemporalWorkflowStatusRequestOpts(requestParameters: GetTemporalWorkflowStatusRequest): Promise<runtime.RequestOpts>;
|
|
100
131
|
/**
|
|
101
|
-
*
|
|
102
|
-
* @summary Workflow
|
|
132
|
+
* Get live Temporal status for any workflow owned by the caller\'s tenant.
|
|
133
|
+
* @summary Get Temporal Workflow Status Handler
|
|
103
134
|
* @param {string} workflowId
|
|
104
|
-
* @param {WorkflowAction} action Action to perform
|
|
105
135
|
* @param {string} [authorization]
|
|
106
136
|
* @param {string} [ksUat]
|
|
107
137
|
* @param {*} [options] Override http request option.
|
|
108
138
|
* @throws {RequiredError}
|
|
109
139
|
* @memberof WorkflowsApiInterface
|
|
110
140
|
*/
|
|
111
|
-
|
|
141
|
+
getTemporalWorkflowStatusRaw(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TemporalWorkflowStatusResponse>>;
|
|
112
142
|
/**
|
|
113
|
-
*
|
|
114
|
-
* Workflow
|
|
143
|
+
* Get live Temporal status for any workflow owned by the caller\'s tenant.
|
|
144
|
+
* Get Temporal Workflow Status Handler
|
|
145
|
+
*/
|
|
146
|
+
getTemporalWorkflowStatus(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TemporalWorkflowStatusResponse>;
|
|
147
|
+
/**
|
|
148
|
+
* Creates request options for listDvWorkflows without sending the request
|
|
149
|
+
* @param {number} [limit] Number of items per page
|
|
150
|
+
* @param {number} [offset] Number of items to skip
|
|
151
|
+
* @param {string} [authorization]
|
|
152
|
+
* @param {string} [ksUat]
|
|
153
|
+
* @throws {RequiredError}
|
|
154
|
+
* @memberof WorkflowsApiInterface
|
|
115
155
|
*/
|
|
116
|
-
|
|
156
|
+
listDvWorkflowsRequestOpts(requestParameters: ListDvWorkflowsRequest): Promise<runtime.RequestOpts>;
|
|
157
|
+
/**
|
|
158
|
+
* List all workflows for the current tenant (paginated, DB-backed). ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
|
|
159
|
+
* @summary List Dv Workflows Handler
|
|
160
|
+
* @param {number} [limit] Number of items per page
|
|
161
|
+
* @param {number} [offset] Number of items to skip
|
|
162
|
+
* @param {string} [authorization]
|
|
163
|
+
* @param {string} [ksUat]
|
|
164
|
+
* @param {*} [options] Override http request option.
|
|
165
|
+
* @throws {RequiredError}
|
|
166
|
+
* @memberof WorkflowsApiInterface
|
|
167
|
+
*/
|
|
168
|
+
listDvWorkflowsRaw(requestParameters: ListDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
|
|
169
|
+
/**
|
|
170
|
+
* List all workflows for the current tenant (paginated, DB-backed). ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
|
|
171
|
+
* List Dv Workflows Handler
|
|
172
|
+
*/
|
|
173
|
+
listDvWorkflows(requestParameters: ListDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
|
|
117
174
|
}
|
|
118
175
|
/**
|
|
119
176
|
*
|
|
120
177
|
*/
|
|
121
178
|
export declare class WorkflowsApi extends runtime.BaseAPI implements WorkflowsApiInterface {
|
|
122
179
|
/**
|
|
123
|
-
* Creates request options for
|
|
180
|
+
* Creates request options for cancelTemporalWorkflow without sending the request
|
|
181
|
+
*/
|
|
182
|
+
cancelTemporalWorkflowRequestOpts(requestParameters: CancelTemporalWorkflowRequest): Promise<runtime.RequestOpts>;
|
|
183
|
+
/**
|
|
184
|
+
* Cancel any Temporal workflow owned by the caller\'s tenant. No status guard — this is a thin Temporal wrapper. Cancelling an already-terminal workflow is a no-op on the Temporal side.
|
|
185
|
+
* Cancel Temporal Workflow Handler
|
|
186
|
+
*/
|
|
187
|
+
cancelTemporalWorkflowRaw(requestParameters: CancelTemporalWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowCancelResponse>>;
|
|
188
|
+
/**
|
|
189
|
+
* Cancel any Temporal workflow owned by the caller\'s tenant. No status guard — this is a thin Temporal wrapper. Cancelling an already-terminal workflow is a no-op on the Temporal side.
|
|
190
|
+
* Cancel Temporal Workflow Handler
|
|
191
|
+
*/
|
|
192
|
+
cancelTemporalWorkflow(requestParameters: CancelTemporalWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowCancelResponse>;
|
|
193
|
+
/**
|
|
194
|
+
* Creates request options for dvWorkflowRerun without sending the request
|
|
195
|
+
*/
|
|
196
|
+
dvWorkflowRerunRequestOpts(requestParameters: DvWorkflowRerunRequest): Promise<runtime.RequestOpts>;
|
|
197
|
+
/**
|
|
198
|
+
* Rerun a workflow. USER role requires ``can_write`` on the document path.
|
|
199
|
+
* Dv Workflow Rerun Handler
|
|
200
|
+
*/
|
|
201
|
+
dvWorkflowRerunRaw(requestParameters: DvWorkflowRerunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
|
|
202
|
+
/**
|
|
203
|
+
* Rerun a workflow. USER role requires ``can_write`` on the document path.
|
|
204
|
+
* Dv Workflow Rerun Handler
|
|
205
|
+
*/
|
|
206
|
+
dvWorkflowRerun(requestParameters: DvWorkflowRerunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
|
|
207
|
+
/**
|
|
208
|
+
* Creates request options for getDvWorkflow without sending the request
|
|
124
209
|
*/
|
|
125
|
-
|
|
210
|
+
getDvWorkflowRequestOpts(requestParameters: GetDvWorkflowRequest): Promise<runtime.RequestOpts>;
|
|
126
211
|
/**
|
|
127
212
|
* Get single workflow detail with live Temporal status.
|
|
128
|
-
* Get Workflow Handler
|
|
213
|
+
* Get Dv Workflow Handler
|
|
129
214
|
*/
|
|
130
|
-
|
|
215
|
+
getDvWorkflowRaw(requestParameters: GetDvWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
|
|
131
216
|
/**
|
|
132
217
|
* Get single workflow detail with live Temporal status.
|
|
133
|
-
* Get Workflow Handler
|
|
218
|
+
* Get Dv Workflow Handler
|
|
134
219
|
*/
|
|
135
|
-
|
|
220
|
+
getDvWorkflow(requestParameters: GetDvWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
|
|
136
221
|
/**
|
|
137
|
-
* Creates request options for
|
|
222
|
+
* Creates request options for getTemporalWorkflowStatus without sending the request
|
|
138
223
|
*/
|
|
139
|
-
|
|
224
|
+
getTemporalWorkflowStatusRequestOpts(requestParameters: GetTemporalWorkflowStatusRequest): Promise<runtime.RequestOpts>;
|
|
140
225
|
/**
|
|
141
|
-
*
|
|
142
|
-
*
|
|
226
|
+
* Get live Temporal status for any workflow owned by the caller\'s tenant.
|
|
227
|
+
* Get Temporal Workflow Status Handler
|
|
143
228
|
*/
|
|
144
|
-
|
|
229
|
+
getTemporalWorkflowStatusRaw(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TemporalWorkflowStatusResponse>>;
|
|
145
230
|
/**
|
|
146
|
-
*
|
|
147
|
-
*
|
|
231
|
+
* Get live Temporal status for any workflow owned by the caller\'s tenant.
|
|
232
|
+
* Get Temporal Workflow Status Handler
|
|
148
233
|
*/
|
|
149
|
-
|
|
234
|
+
getTemporalWorkflowStatus(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TemporalWorkflowStatusResponse>;
|
|
150
235
|
/**
|
|
151
|
-
* Creates request options for
|
|
236
|
+
* Creates request options for listDvWorkflows without sending the request
|
|
152
237
|
*/
|
|
153
|
-
|
|
238
|
+
listDvWorkflowsRequestOpts(requestParameters: ListDvWorkflowsRequest): Promise<runtime.RequestOpts>;
|
|
154
239
|
/**
|
|
155
|
-
*
|
|
156
|
-
*
|
|
240
|
+
* List all workflows for the current tenant (paginated, DB-backed). ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
|
|
241
|
+
* List Dv Workflows Handler
|
|
157
242
|
*/
|
|
158
|
-
|
|
243
|
+
listDvWorkflowsRaw(requestParameters: ListDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
|
|
159
244
|
/**
|
|
160
|
-
*
|
|
161
|
-
*
|
|
245
|
+
* List all workflows for the current tenant (paginated, DB-backed). ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
|
|
246
|
+
* List Dv Workflows Handler
|
|
162
247
|
*/
|
|
163
|
-
|
|
248
|
+
listDvWorkflows(requestParameters?: ListDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
|
|
164
249
|
}
|
|
@@ -30,12 +30,12 @@ const index_1 = require("../models/index");
|
|
|
30
30
|
*/
|
|
31
31
|
class WorkflowsApi extends runtime.BaseAPI {
|
|
32
32
|
/**
|
|
33
|
-
* Creates request options for
|
|
33
|
+
* Creates request options for cancelTemporalWorkflow without sending the request
|
|
34
34
|
*/
|
|
35
|
-
|
|
35
|
+
cancelTemporalWorkflowRequestOpts(requestParameters) {
|
|
36
36
|
return __awaiter(this, void 0, void 0, function* () {
|
|
37
37
|
if (requestParameters['workflowId'] == null) {
|
|
38
|
-
throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling
|
|
38
|
+
throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling cancelTemporalWorkflow().');
|
|
39
39
|
}
|
|
40
40
|
const queryParameters = {};
|
|
41
41
|
const headerParameters = {};
|
|
@@ -46,50 +46,92 @@ class WorkflowsApi extends runtime.BaseAPI {
|
|
|
46
46
|
urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
|
|
47
47
|
return {
|
|
48
48
|
path: urlPath,
|
|
49
|
-
method: '
|
|
49
|
+
method: 'DELETE',
|
|
50
50
|
headers: headerParameters,
|
|
51
51
|
query: queryParameters,
|
|
52
52
|
};
|
|
53
53
|
});
|
|
54
54
|
}
|
|
55
55
|
/**
|
|
56
|
-
*
|
|
57
|
-
*
|
|
56
|
+
* Cancel any Temporal workflow owned by the caller\'s tenant. No status guard — this is a thin Temporal wrapper. Cancelling an already-terminal workflow is a no-op on the Temporal side.
|
|
57
|
+
* Cancel Temporal Workflow Handler
|
|
58
58
|
*/
|
|
59
|
-
|
|
59
|
+
cancelTemporalWorkflowRaw(requestParameters, initOverrides) {
|
|
60
60
|
return __awaiter(this, void 0, void 0, function* () {
|
|
61
|
-
const requestOptions = yield this.
|
|
61
|
+
const requestOptions = yield this.cancelTemporalWorkflowRequestOpts(requestParameters);
|
|
62
62
|
const response = yield this.request(requestOptions, initOverrides);
|
|
63
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.
|
|
63
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowCancelResponseFromJSON)(jsonValue));
|
|
64
64
|
});
|
|
65
65
|
}
|
|
66
66
|
/**
|
|
67
|
-
*
|
|
68
|
-
*
|
|
67
|
+
* Cancel any Temporal workflow owned by the caller\'s tenant. No status guard — this is a thin Temporal wrapper. Cancelling an already-terminal workflow is a no-op on the Temporal side.
|
|
68
|
+
* Cancel Temporal Workflow Handler
|
|
69
69
|
*/
|
|
70
|
-
|
|
70
|
+
cancelTemporalWorkflow(requestParameters, initOverrides) {
|
|
71
71
|
return __awaiter(this, void 0, void 0, function* () {
|
|
72
|
-
const response = yield this.
|
|
72
|
+
const response = yield this.cancelTemporalWorkflowRaw(requestParameters, initOverrides);
|
|
73
73
|
return yield response.value();
|
|
74
74
|
});
|
|
75
75
|
}
|
|
76
76
|
/**
|
|
77
|
-
* Creates request options for
|
|
77
|
+
* Creates request options for dvWorkflowRerun without sending the request
|
|
78
78
|
*/
|
|
79
|
-
|
|
79
|
+
dvWorkflowRerunRequestOpts(requestParameters) {
|
|
80
80
|
return __awaiter(this, void 0, void 0, function* () {
|
|
81
|
+
if (requestParameters['workflowId'] == null) {
|
|
82
|
+
throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling dvWorkflowRerun().');
|
|
83
|
+
}
|
|
81
84
|
const queryParameters = {};
|
|
82
|
-
|
|
83
|
-
|
|
85
|
+
const headerParameters = {};
|
|
86
|
+
if (requestParameters['authorization'] != null) {
|
|
87
|
+
headerParameters['authorization'] = String(requestParameters['authorization']);
|
|
84
88
|
}
|
|
85
|
-
|
|
86
|
-
|
|
89
|
+
let urlPath = `/v1/workflows/document_versions/{workflow_id}`;
|
|
90
|
+
urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
|
|
91
|
+
return {
|
|
92
|
+
path: urlPath,
|
|
93
|
+
method: 'POST',
|
|
94
|
+
headers: headerParameters,
|
|
95
|
+
query: queryParameters,
|
|
96
|
+
};
|
|
97
|
+
});
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Rerun a workflow. USER role requires ``can_write`` on the document path.
|
|
101
|
+
* Dv Workflow Rerun Handler
|
|
102
|
+
*/
|
|
103
|
+
dvWorkflowRerunRaw(requestParameters, initOverrides) {
|
|
104
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
105
|
+
const requestOptions = yield this.dvWorkflowRerunRequestOpts(requestParameters);
|
|
106
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
107
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowActionResponseFromJSON)(jsonValue));
|
|
108
|
+
});
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* Rerun a workflow. USER role requires ``can_write`` on the document path.
|
|
112
|
+
* Dv Workflow Rerun Handler
|
|
113
|
+
*/
|
|
114
|
+
dvWorkflowRerun(requestParameters, initOverrides) {
|
|
115
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
116
|
+
const response = yield this.dvWorkflowRerunRaw(requestParameters, initOverrides);
|
|
117
|
+
return yield response.value();
|
|
118
|
+
});
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Creates request options for getDvWorkflow without sending the request
|
|
122
|
+
*/
|
|
123
|
+
getDvWorkflowRequestOpts(requestParameters) {
|
|
124
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
125
|
+
if (requestParameters['workflowId'] == null) {
|
|
126
|
+
throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling getDvWorkflow().');
|
|
87
127
|
}
|
|
128
|
+
const queryParameters = {};
|
|
88
129
|
const headerParameters = {};
|
|
89
130
|
if (requestParameters['authorization'] != null) {
|
|
90
131
|
headerParameters['authorization'] = String(requestParameters['authorization']);
|
|
91
132
|
}
|
|
92
|
-
let urlPath = `/v1/workflows`;
|
|
133
|
+
let urlPath = `/v1/workflows/document_versions/{workflow_id}`;
|
|
134
|
+
urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
|
|
93
135
|
return {
|
|
94
136
|
path: urlPath,
|
|
95
137
|
method: 'GET',
|
|
@@ -99,41 +141,35 @@ class WorkflowsApi extends runtime.BaseAPI {
|
|
|
99
141
|
});
|
|
100
142
|
}
|
|
101
143
|
/**
|
|
102
|
-
*
|
|
103
|
-
*
|
|
144
|
+
* Get single workflow detail with live Temporal status.
|
|
145
|
+
* Get Dv Workflow Handler
|
|
104
146
|
*/
|
|
105
|
-
|
|
147
|
+
getDvWorkflowRaw(requestParameters, initOverrides) {
|
|
106
148
|
return __awaiter(this, void 0, void 0, function* () {
|
|
107
|
-
const requestOptions = yield this.
|
|
149
|
+
const requestOptions = yield this.getDvWorkflowRequestOpts(requestParameters);
|
|
108
150
|
const response = yield this.request(requestOptions, initOverrides);
|
|
109
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.
|
|
151
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowDetailResponseFromJSON)(jsonValue));
|
|
110
152
|
});
|
|
111
153
|
}
|
|
112
154
|
/**
|
|
113
|
-
*
|
|
114
|
-
*
|
|
155
|
+
* Get single workflow detail with live Temporal status.
|
|
156
|
+
* Get Dv Workflow Handler
|
|
115
157
|
*/
|
|
116
|
-
|
|
117
|
-
return __awaiter(this,
|
|
118
|
-
const response = yield this.
|
|
158
|
+
getDvWorkflow(requestParameters, initOverrides) {
|
|
159
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
160
|
+
const response = yield this.getDvWorkflowRaw(requestParameters, initOverrides);
|
|
119
161
|
return yield response.value();
|
|
120
162
|
});
|
|
121
163
|
}
|
|
122
164
|
/**
|
|
123
|
-
* Creates request options for
|
|
165
|
+
* Creates request options for getTemporalWorkflowStatus without sending the request
|
|
124
166
|
*/
|
|
125
|
-
|
|
167
|
+
getTemporalWorkflowStatusRequestOpts(requestParameters) {
|
|
126
168
|
return __awaiter(this, void 0, void 0, function* () {
|
|
127
169
|
if (requestParameters['workflowId'] == null) {
|
|
128
|
-
throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling
|
|
129
|
-
}
|
|
130
|
-
if (requestParameters['action'] == null) {
|
|
131
|
-
throw new runtime.RequiredError('action', 'Required parameter "action" was null or undefined when calling workflowAction().');
|
|
170
|
+
throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling getTemporalWorkflowStatus().');
|
|
132
171
|
}
|
|
133
172
|
const queryParameters = {};
|
|
134
|
-
if (requestParameters['action'] != null) {
|
|
135
|
-
queryParameters['action'] = requestParameters['action'];
|
|
136
|
-
}
|
|
137
173
|
const headerParameters = {};
|
|
138
174
|
if (requestParameters['authorization'] != null) {
|
|
139
175
|
headerParameters['authorization'] = String(requestParameters['authorization']);
|
|
@@ -142,30 +178,76 @@ class WorkflowsApi extends runtime.BaseAPI {
|
|
|
142
178
|
urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
|
|
143
179
|
return {
|
|
144
180
|
path: urlPath,
|
|
145
|
-
method: '
|
|
181
|
+
method: 'GET',
|
|
146
182
|
headers: headerParameters,
|
|
147
183
|
query: queryParameters,
|
|
148
184
|
};
|
|
149
185
|
});
|
|
150
186
|
}
|
|
151
187
|
/**
|
|
152
|
-
*
|
|
153
|
-
* Workflow
|
|
188
|
+
* Get live Temporal status for any workflow owned by the caller\'s tenant.
|
|
189
|
+
* Get Temporal Workflow Status Handler
|
|
154
190
|
*/
|
|
155
|
-
|
|
191
|
+
getTemporalWorkflowStatusRaw(requestParameters, initOverrides) {
|
|
156
192
|
return __awaiter(this, void 0, void 0, function* () {
|
|
157
|
-
const requestOptions = yield this.
|
|
193
|
+
const requestOptions = yield this.getTemporalWorkflowStatusRequestOpts(requestParameters);
|
|
158
194
|
const response = yield this.request(requestOptions, initOverrides);
|
|
159
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.
|
|
195
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TemporalWorkflowStatusResponseFromJSON)(jsonValue));
|
|
196
|
+
});
|
|
197
|
+
}
|
|
198
|
+
/**
|
|
199
|
+
* Get live Temporal status for any workflow owned by the caller\'s tenant.
|
|
200
|
+
* Get Temporal Workflow Status Handler
|
|
201
|
+
*/
|
|
202
|
+
getTemporalWorkflowStatus(requestParameters, initOverrides) {
|
|
203
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
204
|
+
const response = yield this.getTemporalWorkflowStatusRaw(requestParameters, initOverrides);
|
|
205
|
+
return yield response.value();
|
|
160
206
|
});
|
|
161
207
|
}
|
|
162
208
|
/**
|
|
163
|
-
*
|
|
164
|
-
* Workflow Action Handler
|
|
209
|
+
* Creates request options for listDvWorkflows without sending the request
|
|
165
210
|
*/
|
|
166
|
-
|
|
211
|
+
listDvWorkflowsRequestOpts(requestParameters) {
|
|
167
212
|
return __awaiter(this, void 0, void 0, function* () {
|
|
168
|
-
const
|
|
213
|
+
const queryParameters = {};
|
|
214
|
+
if (requestParameters['limit'] != null) {
|
|
215
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
216
|
+
}
|
|
217
|
+
if (requestParameters['offset'] != null) {
|
|
218
|
+
queryParameters['offset'] = requestParameters['offset'];
|
|
219
|
+
}
|
|
220
|
+
const headerParameters = {};
|
|
221
|
+
if (requestParameters['authorization'] != null) {
|
|
222
|
+
headerParameters['authorization'] = String(requestParameters['authorization']);
|
|
223
|
+
}
|
|
224
|
+
let urlPath = `/v1/workflows/document_versions`;
|
|
225
|
+
return {
|
|
226
|
+
path: urlPath,
|
|
227
|
+
method: 'GET',
|
|
228
|
+
headers: headerParameters,
|
|
229
|
+
query: queryParameters,
|
|
230
|
+
};
|
|
231
|
+
});
|
|
232
|
+
}
|
|
233
|
+
/**
|
|
234
|
+
* List all workflows for the current tenant (paginated, DB-backed). ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
|
|
235
|
+
* List Dv Workflows Handler
|
|
236
|
+
*/
|
|
237
|
+
listDvWorkflowsRaw(requestParameters, initOverrides) {
|
|
238
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
239
|
+
const requestOptions = yield this.listDvWorkflowsRequestOpts(requestParameters);
|
|
240
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
241
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseWorkflowSummaryResponseFromJSON)(jsonValue));
|
|
242
|
+
});
|
|
243
|
+
}
|
|
244
|
+
/**
|
|
245
|
+
* List all workflows for the current tenant (paginated, DB-backed). ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
|
|
246
|
+
* List Dv Workflows Handler
|
|
247
|
+
*/
|
|
248
|
+
listDvWorkflows() {
|
|
249
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
250
|
+
const response = yield this.listDvWorkflowsRaw(requestParameters, initOverrides);
|
|
169
251
|
return yield response.value();
|
|
170
252
|
});
|
|
171
253
|
}
|