@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.
Files changed (77) hide show
  1. package/.openapi-generator/FILES +12 -2
  2. package/README.md +16 -6
  3. package/dist/apis/FoldersApi.d.ts +63 -4
  4. package/dist/apis/FoldersApi.js +64 -3
  5. package/dist/apis/PathPartsApi.d.ts +45 -1
  6. package/dist/apis/PathPartsApi.js +44 -0
  7. package/dist/apis/SectionsApi.d.ts +44 -0
  8. package/dist/apis/SectionsApi.js +43 -0
  9. package/dist/apis/WorkflowsApi.d.ts +144 -59
  10. package/dist/apis/WorkflowsApi.js +131 -49
  11. package/dist/esm/apis/FoldersApi.d.ts +63 -4
  12. package/dist/esm/apis/FoldersApi.js +64 -3
  13. package/dist/esm/apis/PathPartsApi.d.ts +45 -1
  14. package/dist/esm/apis/PathPartsApi.js +45 -1
  15. package/dist/esm/apis/SectionsApi.d.ts +44 -0
  16. package/dist/esm/apis/SectionsApi.js +43 -0
  17. package/dist/esm/apis/WorkflowsApi.d.ts +144 -59
  18. package/dist/esm/apis/WorkflowsApi.js +132 -50
  19. package/dist/esm/models/AncestryResponse.d.ts +48 -0
  20. package/dist/esm/models/AncestryResponse.js +45 -0
  21. package/dist/esm/models/PathPartAncestorItem.d.ts +96 -0
  22. package/dist/esm/models/PathPartAncestorItem.js +77 -0
  23. package/dist/esm/models/SearchSortOrder.d.ts +26 -0
  24. package/dist/esm/models/SearchSortOrder.js +44 -0
  25. package/dist/esm/models/SearchablePartType.d.ts +25 -0
  26. package/dist/esm/models/SearchablePartType.js +43 -0
  27. package/dist/esm/models/TemporalWorkflowStatusResponse.d.ts +83 -0
  28. package/dist/esm/models/TemporalWorkflowStatusResponse.js +66 -0
  29. package/dist/esm/models/WorkflowActionResponse.d.ts +1 -1
  30. package/dist/esm/models/WorkflowCancelResponse.d.ts +53 -0
  31. package/dist/esm/models/WorkflowCancelResponse.js +48 -0
  32. package/dist/esm/models/index.d.ts +6 -1
  33. package/dist/esm/models/index.js +6 -1
  34. package/dist/models/AncestryResponse.d.ts +48 -0
  35. package/dist/models/AncestryResponse.js +53 -0
  36. package/dist/models/PathPartAncestorItem.d.ts +96 -0
  37. package/dist/models/PathPartAncestorItem.js +85 -0
  38. package/dist/models/SearchSortOrder.d.ts +26 -0
  39. package/dist/models/SearchSortOrder.js +52 -0
  40. package/dist/models/SearchablePartType.d.ts +25 -0
  41. package/dist/models/SearchablePartType.js +51 -0
  42. package/dist/models/TemporalWorkflowStatusResponse.d.ts +83 -0
  43. package/dist/models/TemporalWorkflowStatusResponse.js +74 -0
  44. package/dist/models/WorkflowActionResponse.d.ts +1 -1
  45. package/dist/models/WorkflowCancelResponse.d.ts +53 -0
  46. package/dist/models/WorkflowCancelResponse.js +56 -0
  47. package/dist/models/index.d.ts +6 -1
  48. package/dist/models/index.js +6 -1
  49. package/docs/AncestryResponse.md +35 -0
  50. package/docs/FoldersApi.md +94 -4
  51. package/docs/PathPartAncestorItem.md +51 -0
  52. package/docs/PathPartsApi.md +75 -0
  53. package/docs/{WorkflowAction.md → SearchSortOrder.md} +5 -5
  54. package/docs/SearchablePartType.md +33 -0
  55. package/docs/SectionsApi.md +75 -0
  56. package/docs/TemporalWorkflowStatusResponse.md +47 -0
  57. package/docs/WorkflowActionResponse.md +1 -1
  58. package/docs/WorkflowCancelResponse.md +37 -0
  59. package/docs/WorkflowsApi.md +183 -36
  60. package/package.json +1 -1
  61. package/src/apis/FoldersApi.ts +136 -7
  62. package/src/apis/PathPartsApi.ts +88 -0
  63. package/src/apis/SectionsApi.ts +81 -0
  64. package/src/apis/WorkflowsApi.ts +249 -90
  65. package/src/models/AncestryResponse.ts +91 -0
  66. package/src/models/PathPartAncestorItem.ts +165 -0
  67. package/src/models/SearchSortOrder.ts +54 -0
  68. package/src/models/SearchablePartType.ts +53 -0
  69. package/src/models/TemporalWorkflowStatusResponse.ts +136 -0
  70. package/src/models/WorkflowActionResponse.ts +1 -1
  71. package/src/models/WorkflowCancelResponse.ts +92 -0
  72. package/src/models/index.ts +6 -1
  73. package/dist/esm/models/WorkflowAction.d.ts +0 -25
  74. package/dist/esm/models/WorkflowAction.js +0 -43
  75. package/dist/models/WorkflowAction.d.ts +0 -25
  76. package/dist/models/WorkflowAction.js +0 -51
  77. 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, WorkflowAction, WorkflowActionResponse, WorkflowDetailResponse } from '../models/index';
14
- export interface GetWorkflowRequest {
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 ListWorkflowsRequest {
20
- limit?: number;
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 WorkflowActionRequest {
24
+ export interface GetDvWorkflowRequest {
26
25
  workflowId: string;
27
- action: WorkflowAction;
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 getWorkflow without sending the request
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
- getWorkflowRequestOpts(requestParameters: GetWorkflowRequest): Promise<runtime.RequestOpts>;
55
+ cancelTemporalWorkflowRequestOpts(requestParameters: CancelTemporalWorkflowRequest): Promise<runtime.RequestOpts>;
47
56
  /**
48
- * Get single workflow detail with live Temporal status.
49
- * @summary Get Workflow Handler
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
- getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
66
+ cancelTemporalWorkflowRaw(requestParameters: CancelTemporalWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowCancelResponse>>;
58
67
  /**
59
- * Get single workflow detail with live Temporal status.
60
- * Get Workflow Handler
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
- getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
71
+ cancelTemporalWorkflow(requestParameters: CancelTemporalWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowCancelResponse>;
63
72
  /**
64
- * Creates request options for listWorkflows without sending the request
65
- * @param {number} [limit] Number of items per page
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
- listWorkflowsRequestOpts(requestParameters: ListWorkflowsRequest): Promise<runtime.RequestOpts>;
80
+ dvWorkflowRerunRequestOpts(requestParameters: DvWorkflowRerunRequest): Promise<runtime.RequestOpts>;
73
81
  /**
74
- * List all workflows for the current tenant (paginated, DB-backed).
75
- * @summary List Workflows Handler
76
- * @param {number} [limit] Number of items per page
77
- * @param {number} [offset] Number of items to skip
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
- listWorkflowsRaw(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
116
+ getDvWorkflowRaw(requestParameters: GetDvWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
85
117
  /**
86
- * List all workflows for the current tenant (paginated, DB-backed).
87
- * List Workflows Handler
118
+ * Get single workflow detail with live Temporal status.
119
+ * Get Dv Workflow Handler
88
120
  */
89
- listWorkflows(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
121
+ getDvWorkflow(requestParameters: GetDvWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
90
122
  /**
91
- * Creates request options for workflowAction without sending the request
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
- workflowActionRequestOpts(requestParameters: WorkflowActionRequest): Promise<runtime.RequestOpts>;
130
+ getTemporalWorkflowStatusRequestOpts(requestParameters: GetTemporalWorkflowStatusRequest): Promise<runtime.RequestOpts>;
100
131
  /**
101
- * Cancel or rerun a workflow (OWNER/ADMIN only).
102
- * @summary Workflow Action Handler
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
- workflowActionRaw(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
141
+ getTemporalWorkflowStatusRaw(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TemporalWorkflowStatusResponse>>;
112
142
  /**
113
- * Cancel or rerun a workflow (OWNER/ADMIN only).
114
- * Workflow Action Handler
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
- workflowAction(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
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 getWorkflow without sending the request
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
- getWorkflowRequestOpts(requestParameters: GetWorkflowRequest): Promise<runtime.RequestOpts>;
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
- getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
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
- getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
220
+ getDvWorkflow(requestParameters: GetDvWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
136
221
  /**
137
- * Creates request options for listWorkflows without sending the request
222
+ * Creates request options for getTemporalWorkflowStatus without sending the request
138
223
  */
139
- listWorkflowsRequestOpts(requestParameters: ListWorkflowsRequest): Promise<runtime.RequestOpts>;
224
+ getTemporalWorkflowStatusRequestOpts(requestParameters: GetTemporalWorkflowStatusRequest): Promise<runtime.RequestOpts>;
140
225
  /**
141
- * List all workflows for the current tenant (paginated, DB-backed).
142
- * List Workflows Handler
226
+ * Get live Temporal status for any workflow owned by the caller\'s tenant.
227
+ * Get Temporal Workflow Status Handler
143
228
  */
144
- listWorkflowsRaw(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
229
+ getTemporalWorkflowStatusRaw(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TemporalWorkflowStatusResponse>>;
145
230
  /**
146
- * List all workflows for the current tenant (paginated, DB-backed).
147
- * List Workflows Handler
231
+ * Get live Temporal status for any workflow owned by the caller\'s tenant.
232
+ * Get Temporal Workflow Status Handler
148
233
  */
149
- listWorkflows(requestParameters?: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
234
+ getTemporalWorkflowStatus(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TemporalWorkflowStatusResponse>;
150
235
  /**
151
- * Creates request options for workflowAction without sending the request
236
+ * Creates request options for listDvWorkflows without sending the request
152
237
  */
153
- workflowActionRequestOpts(requestParameters: WorkflowActionRequest): Promise<runtime.RequestOpts>;
238
+ listDvWorkflowsRequestOpts(requestParameters: ListDvWorkflowsRequest): Promise<runtime.RequestOpts>;
154
239
  /**
155
- * Cancel or rerun a workflow (OWNER/ADMIN only).
156
- * Workflow Action Handler
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
- workflowActionRaw(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
243
+ listDvWorkflowsRaw(requestParameters: ListDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
159
244
  /**
160
- * Cancel or rerun a workflow (OWNER/ADMIN only).
161
- * Workflow Action Handler
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
- workflowAction(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
248
+ listDvWorkflows(requestParameters?: ListDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
164
249
  }
@@ -21,18 +21,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { PaginatedResponseWorkflowSummaryResponseFromJSON, WorkflowActionResponseFromJSON, WorkflowDetailResponseFromJSON, } from '../models/index';
24
+ import { PaginatedResponseWorkflowSummaryResponseFromJSON, TemporalWorkflowStatusResponseFromJSON, WorkflowActionResponseFromJSON, WorkflowCancelResponseFromJSON, WorkflowDetailResponseFromJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
28
28
  export class WorkflowsApi extends runtime.BaseAPI {
29
29
  /**
30
- * Creates request options for getWorkflow without sending the request
30
+ * Creates request options for cancelTemporalWorkflow without sending the request
31
31
  */
32
- getWorkflowRequestOpts(requestParameters) {
32
+ cancelTemporalWorkflowRequestOpts(requestParameters) {
33
33
  return __awaiter(this, void 0, void 0, function* () {
34
34
  if (requestParameters['workflowId'] == null) {
35
- throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling getWorkflow().');
35
+ throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling cancelTemporalWorkflow().');
36
36
  }
37
37
  const queryParameters = {};
38
38
  const headerParameters = {};
@@ -43,50 +43,92 @@ export class WorkflowsApi extends runtime.BaseAPI {
43
43
  urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
44
44
  return {
45
45
  path: urlPath,
46
- method: 'GET',
46
+ method: 'DELETE',
47
47
  headers: headerParameters,
48
48
  query: queryParameters,
49
49
  };
50
50
  });
51
51
  }
52
52
  /**
53
- * Get single workflow detail with live Temporal status.
54
- * Get Workflow Handler
53
+ * 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.
54
+ * Cancel Temporal Workflow Handler
55
55
  */
56
- getWorkflowRaw(requestParameters, initOverrides) {
56
+ cancelTemporalWorkflowRaw(requestParameters, initOverrides) {
57
57
  return __awaiter(this, void 0, void 0, function* () {
58
- const requestOptions = yield this.getWorkflowRequestOpts(requestParameters);
58
+ const requestOptions = yield this.cancelTemporalWorkflowRequestOpts(requestParameters);
59
59
  const response = yield this.request(requestOptions, initOverrides);
60
- return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowDetailResponseFromJSON(jsonValue));
60
+ return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowCancelResponseFromJSON(jsonValue));
61
61
  });
62
62
  }
63
63
  /**
64
- * Get single workflow detail with live Temporal status.
65
- * Get Workflow Handler
64
+ * 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.
65
+ * Cancel Temporal Workflow Handler
66
66
  */
67
- getWorkflow(requestParameters, initOverrides) {
67
+ cancelTemporalWorkflow(requestParameters, initOverrides) {
68
68
  return __awaiter(this, void 0, void 0, function* () {
69
- const response = yield this.getWorkflowRaw(requestParameters, initOverrides);
69
+ const response = yield this.cancelTemporalWorkflowRaw(requestParameters, initOverrides);
70
70
  return yield response.value();
71
71
  });
72
72
  }
73
73
  /**
74
- * Creates request options for listWorkflows without sending the request
74
+ * Creates request options for dvWorkflowRerun without sending the request
75
75
  */
76
- listWorkflowsRequestOpts(requestParameters) {
76
+ dvWorkflowRerunRequestOpts(requestParameters) {
77
77
  return __awaiter(this, void 0, void 0, function* () {
78
+ if (requestParameters['workflowId'] == null) {
79
+ throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling dvWorkflowRerun().');
80
+ }
78
81
  const queryParameters = {};
79
- if (requestParameters['limit'] != null) {
80
- queryParameters['limit'] = requestParameters['limit'];
82
+ const headerParameters = {};
83
+ if (requestParameters['authorization'] != null) {
84
+ headerParameters['authorization'] = String(requestParameters['authorization']);
81
85
  }
82
- if (requestParameters['offset'] != null) {
83
- queryParameters['offset'] = requestParameters['offset'];
86
+ let urlPath = `/v1/workflows/document_versions/{workflow_id}`;
87
+ urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
88
+ return {
89
+ path: urlPath,
90
+ method: 'POST',
91
+ headers: headerParameters,
92
+ query: queryParameters,
93
+ };
94
+ });
95
+ }
96
+ /**
97
+ * Rerun a workflow. USER role requires ``can_write`` on the document path.
98
+ * Dv Workflow Rerun Handler
99
+ */
100
+ dvWorkflowRerunRaw(requestParameters, initOverrides) {
101
+ return __awaiter(this, void 0, void 0, function* () {
102
+ const requestOptions = yield this.dvWorkflowRerunRequestOpts(requestParameters);
103
+ const response = yield this.request(requestOptions, initOverrides);
104
+ return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowActionResponseFromJSON(jsonValue));
105
+ });
106
+ }
107
+ /**
108
+ * Rerun a workflow. USER role requires ``can_write`` on the document path.
109
+ * Dv Workflow Rerun Handler
110
+ */
111
+ dvWorkflowRerun(requestParameters, initOverrides) {
112
+ return __awaiter(this, void 0, void 0, function* () {
113
+ const response = yield this.dvWorkflowRerunRaw(requestParameters, initOverrides);
114
+ return yield response.value();
115
+ });
116
+ }
117
+ /**
118
+ * Creates request options for getDvWorkflow without sending the request
119
+ */
120
+ getDvWorkflowRequestOpts(requestParameters) {
121
+ return __awaiter(this, void 0, void 0, function* () {
122
+ if (requestParameters['workflowId'] == null) {
123
+ throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling getDvWorkflow().');
84
124
  }
125
+ const queryParameters = {};
85
126
  const headerParameters = {};
86
127
  if (requestParameters['authorization'] != null) {
87
128
  headerParameters['authorization'] = String(requestParameters['authorization']);
88
129
  }
89
- let urlPath = `/v1/workflows`;
130
+ let urlPath = `/v1/workflows/document_versions/{workflow_id}`;
131
+ urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
90
132
  return {
91
133
  path: urlPath,
92
134
  method: 'GET',
@@ -96,41 +138,35 @@ export class WorkflowsApi extends runtime.BaseAPI {
96
138
  });
97
139
  }
98
140
  /**
99
- * List all workflows for the current tenant (paginated, DB-backed).
100
- * List Workflows Handler
141
+ * Get single workflow detail with live Temporal status.
142
+ * Get Dv Workflow Handler
101
143
  */
102
- listWorkflowsRaw(requestParameters, initOverrides) {
144
+ getDvWorkflowRaw(requestParameters, initOverrides) {
103
145
  return __awaiter(this, void 0, void 0, function* () {
104
- const requestOptions = yield this.listWorkflowsRequestOpts(requestParameters);
146
+ const requestOptions = yield this.getDvWorkflowRequestOpts(requestParameters);
105
147
  const response = yield this.request(requestOptions, initOverrides);
106
- return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseWorkflowSummaryResponseFromJSON(jsonValue));
148
+ return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowDetailResponseFromJSON(jsonValue));
107
149
  });
108
150
  }
109
151
  /**
110
- * List all workflows for the current tenant (paginated, DB-backed).
111
- * List Workflows Handler
152
+ * Get single workflow detail with live Temporal status.
153
+ * Get Dv Workflow Handler
112
154
  */
113
- listWorkflows() {
114
- return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
115
- const response = yield this.listWorkflowsRaw(requestParameters, initOverrides);
155
+ getDvWorkflow(requestParameters, initOverrides) {
156
+ return __awaiter(this, void 0, void 0, function* () {
157
+ const response = yield this.getDvWorkflowRaw(requestParameters, initOverrides);
116
158
  return yield response.value();
117
159
  });
118
160
  }
119
161
  /**
120
- * Creates request options for workflowAction without sending the request
162
+ * Creates request options for getTemporalWorkflowStatus without sending the request
121
163
  */
122
- workflowActionRequestOpts(requestParameters) {
164
+ getTemporalWorkflowStatusRequestOpts(requestParameters) {
123
165
  return __awaiter(this, void 0, void 0, function* () {
124
166
  if (requestParameters['workflowId'] == null) {
125
- throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling workflowAction().');
126
- }
127
- if (requestParameters['action'] == null) {
128
- throw new runtime.RequiredError('action', 'Required parameter "action" was null or undefined when calling workflowAction().');
167
+ throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling getTemporalWorkflowStatus().');
129
168
  }
130
169
  const queryParameters = {};
131
- if (requestParameters['action'] != null) {
132
- queryParameters['action'] = requestParameters['action'];
133
- }
134
170
  const headerParameters = {};
135
171
  if (requestParameters['authorization'] != null) {
136
172
  headerParameters['authorization'] = String(requestParameters['authorization']);
@@ -139,30 +175,76 @@ export class WorkflowsApi extends runtime.BaseAPI {
139
175
  urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
140
176
  return {
141
177
  path: urlPath,
142
- method: 'POST',
178
+ method: 'GET',
143
179
  headers: headerParameters,
144
180
  query: queryParameters,
145
181
  };
146
182
  });
147
183
  }
148
184
  /**
149
- * Cancel or rerun a workflow (OWNER/ADMIN only).
150
- * Workflow Action Handler
185
+ * Get live Temporal status for any workflow owned by the caller\'s tenant.
186
+ * Get Temporal Workflow Status Handler
151
187
  */
152
- workflowActionRaw(requestParameters, initOverrides) {
188
+ getTemporalWorkflowStatusRaw(requestParameters, initOverrides) {
153
189
  return __awaiter(this, void 0, void 0, function* () {
154
- const requestOptions = yield this.workflowActionRequestOpts(requestParameters);
190
+ const requestOptions = yield this.getTemporalWorkflowStatusRequestOpts(requestParameters);
155
191
  const response = yield this.request(requestOptions, initOverrides);
156
- return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowActionResponseFromJSON(jsonValue));
192
+ return new runtime.JSONApiResponse(response, (jsonValue) => TemporalWorkflowStatusResponseFromJSON(jsonValue));
193
+ });
194
+ }
195
+ /**
196
+ * Get live Temporal status for any workflow owned by the caller\'s tenant.
197
+ * Get Temporal Workflow Status Handler
198
+ */
199
+ getTemporalWorkflowStatus(requestParameters, initOverrides) {
200
+ return __awaiter(this, void 0, void 0, function* () {
201
+ const response = yield this.getTemporalWorkflowStatusRaw(requestParameters, initOverrides);
202
+ return yield response.value();
157
203
  });
158
204
  }
159
205
  /**
160
- * Cancel or rerun a workflow (OWNER/ADMIN only).
161
- * Workflow Action Handler
206
+ * Creates request options for listDvWorkflows without sending the request
162
207
  */
163
- workflowAction(requestParameters, initOverrides) {
208
+ listDvWorkflowsRequestOpts(requestParameters) {
164
209
  return __awaiter(this, void 0, void 0, function* () {
165
- const response = yield this.workflowActionRaw(requestParameters, initOverrides);
210
+ const queryParameters = {};
211
+ if (requestParameters['limit'] != null) {
212
+ queryParameters['limit'] = requestParameters['limit'];
213
+ }
214
+ if (requestParameters['offset'] != null) {
215
+ queryParameters['offset'] = requestParameters['offset'];
216
+ }
217
+ const headerParameters = {};
218
+ if (requestParameters['authorization'] != null) {
219
+ headerParameters['authorization'] = String(requestParameters['authorization']);
220
+ }
221
+ let urlPath = `/v1/workflows/document_versions`;
222
+ return {
223
+ path: urlPath,
224
+ method: 'GET',
225
+ headers: headerParameters,
226
+ query: queryParameters,
227
+ };
228
+ });
229
+ }
230
+ /**
231
+ * List all workflows for the current tenant (paginated, DB-backed). ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
232
+ * List Dv Workflows Handler
233
+ */
234
+ listDvWorkflowsRaw(requestParameters, initOverrides) {
235
+ return __awaiter(this, void 0, void 0, function* () {
236
+ const requestOptions = yield this.listDvWorkflowsRequestOpts(requestParameters);
237
+ const response = yield this.request(requestOptions, initOverrides);
238
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseWorkflowSummaryResponseFromJSON(jsonValue));
239
+ });
240
+ }
241
+ /**
242
+ * List all workflows for the current tenant (paginated, DB-backed). ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
243
+ * List Dv Workflows Handler
244
+ */
245
+ listDvWorkflows() {
246
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
247
+ const response = yield this.listDvWorkflowsRaw(requestParameters, initOverrides);
166
248
  return yield response.value();
167
249
  });
168
250
  }
@@ -0,0 +1,48 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { PathPartAncestorItem } from './PathPartAncestorItem';
13
+ /**
14
+ * Response containing the ancestry chain from root to target (inclusive).
15
+ * @export
16
+ * @interface AncestryResponse
17
+ */
18
+ export interface AncestryResponse {
19
+ /**
20
+ * Ancestors ordered root-to-leaf
21
+ * @type {Array<PathPartAncestorItem>}
22
+ * @memberof AncestryResponse
23
+ */
24
+ ancestors: Array<PathPartAncestorItem>;
25
+ }
26
+ /**
27
+ * Check if a given object implements the AncestryResponse interface.
28
+ */
29
+ export declare function instanceOfAncestryResponse(value: object): value is AncestryResponse;
30
+ export declare function AncestryResponseFromJSON(json: any): AncestryResponse;
31
+ export declare function AncestryResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AncestryResponse;
32
+ export declare function AncestryResponseToJSON(json: any): AncestryResponse;
33
+ export declare function AncestryResponseToJSONTyped(value?: AncestryResponse | null, ignoreDiscriminator?: boolean): any;
34
+ export declare const AncestryResponsePropertyValidationAttributesMap: {
35
+ [property: string]: {
36
+ maxLength?: number;
37
+ minLength?: number;
38
+ pattern?: string;
39
+ maximum?: number;
40
+ exclusiveMaximum?: boolean;
41
+ minimum?: number;
42
+ exclusiveMinimum?: boolean;
43
+ multipleOf?: number;
44
+ maxItems?: number;
45
+ minItems?: number;
46
+ uniqueItems?: boolean;
47
+ };
48
+ };