@knowledge-stack/ksapi 1.16.0 → 1.17.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +6 -2
- package/README.md +2 -2
- package/dist/apis/AuthApi.d.ts +1 -30
- package/dist/apis/AuthApi.js +0 -39
- package/dist/apis/DocumentsApi.d.ts +10 -10
- package/dist/apis/DocumentsApi.js +6 -6
- package/dist/apis/FoldersApi.d.ts +10 -10
- package/dist/apis/FoldersApi.js +6 -6
- package/dist/apis/WorkflowsApi.d.ts +117 -0
- package/dist/apis/WorkflowsApi.js +137 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/AuthApi.d.ts +1 -30
- package/dist/esm/apis/AuthApi.js +1 -40
- package/dist/esm/apis/DocumentsApi.d.ts +10 -10
- package/dist/esm/apis/DocumentsApi.js +6 -6
- package/dist/esm/apis/FoldersApi.d.ts +10 -10
- package/dist/esm/apis/FoldersApi.js +6 -6
- package/dist/esm/apis/WorkflowsApi.d.ts +117 -0
- package/dist/esm/apis/WorkflowsApi.js +133 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/CreateDocumentRequest.d.ts +2 -2
- package/dist/esm/models/CreateDocumentRequest.js +3 -3
- package/dist/esm/models/CreateFolderRequest.d.ts +2 -2
- package/dist/esm/models/CreateFolderRequest.js +3 -3
- package/dist/esm/models/DocumentResponse.d.ts +2 -2
- package/dist/esm/models/DocumentResponse.js +3 -3
- package/dist/esm/models/FolderResponse.d.ts +2 -2
- package/dist/esm/models/FolderResponse.js +3 -3
- package/dist/esm/models/PaginatedResponseWorkflowSummaryResponse.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseWorkflowSummaryResponse.js +70 -0
- package/dist/esm/models/PipelineStatus.d.ts +1 -0
- package/dist/esm/models/PipelineStatus.js +2 -1
- package/dist/esm/models/UpdateDocumentRequest.d.ts +2 -2
- package/dist/esm/models/UpdateDocumentRequest.js +2 -2
- package/dist/esm/models/UpdateFolderRequest.d.ts +2 -2
- package/dist/esm/models/UpdateFolderRequest.js +2 -2
- package/dist/esm/models/WorkflowAction.d.ts +25 -0
- package/dist/esm/models/WorkflowAction.js +43 -0
- package/dist/esm/models/WorkflowActionResponse.d.ts +59 -0
- package/dist/esm/models/WorkflowActionResponse.js +52 -0
- package/dist/esm/models/WorkflowDetailResponse.d.ts +132 -0
- package/dist/esm/models/WorkflowDetailResponse.js +93 -0
- package/dist/esm/models/WorkflowSummaryResponse.d.ts +90 -0
- package/dist/esm/models/WorkflowSummaryResponse.js +69 -0
- package/dist/esm/models/index.d.ts +5 -2
- package/dist/esm/models/index.js +5 -2
- package/dist/models/CreateDocumentRequest.d.ts +2 -2
- package/dist/models/CreateDocumentRequest.js +3 -3
- package/dist/models/CreateFolderRequest.d.ts +2 -2
- package/dist/models/CreateFolderRequest.js +3 -3
- package/dist/models/DocumentResponse.d.ts +2 -2
- package/dist/models/DocumentResponse.js +3 -3
- package/dist/models/FolderResponse.d.ts +2 -2
- package/dist/models/FolderResponse.js +3 -3
- package/dist/models/PaginatedResponseWorkflowSummaryResponse.d.ts +66 -0
- package/dist/models/PaginatedResponseWorkflowSummaryResponse.js +78 -0
- package/dist/models/PipelineStatus.d.ts +1 -0
- package/dist/models/PipelineStatus.js +2 -1
- package/dist/models/UpdateDocumentRequest.d.ts +2 -2
- package/dist/models/UpdateDocumentRequest.js +2 -2
- package/dist/models/UpdateFolderRequest.d.ts +2 -2
- package/dist/models/UpdateFolderRequest.js +2 -2
- package/dist/models/WorkflowAction.d.ts +25 -0
- package/dist/models/WorkflowAction.js +51 -0
- package/dist/models/WorkflowActionResponse.d.ts +59 -0
- package/dist/models/WorkflowActionResponse.js +60 -0
- package/dist/models/WorkflowDetailResponse.d.ts +132 -0
- package/dist/models/WorkflowDetailResponse.js +101 -0
- package/dist/models/WorkflowSummaryResponse.d.ts +90 -0
- package/dist/models/WorkflowSummaryResponse.js +77 -0
- package/dist/models/index.d.ts +5 -2
- package/dist/models/index.js +5 -2
- package/package.json +1 -1
- package/src/apis/AuthApi.ts +0 -80
- package/src/apis/DocumentsApi.ts +12 -12
- package/src/apis/FoldersApi.ts +12 -12
- package/src/apis/WorkflowsApi.ts +249 -0
- package/src/apis/index.ts +1 -0
- package/src/models/CreateDocumentRequest.ts +5 -5
- package/src/models/CreateFolderRequest.ts +5 -5
- package/src/models/DocumentResponse.ts +5 -5
- package/src/models/FolderResponse.ts +5 -5
- package/src/models/PaginatedResponseWorkflowSummaryResponse.ts +130 -0
- package/src/models/PipelineStatus.ts +2 -1
- package/src/models/UpdateDocumentRequest.ts +4 -4
- package/src/models/UpdateFolderRequest.ts +4 -4
- package/src/models/WorkflowAction.ts +53 -0
- package/src/models/WorkflowActionResponse.ts +101 -0
- package/src/models/WorkflowDetailResponse.ts +215 -0
- package/src/models/WorkflowSummaryResponse.ts +154 -0
- package/src/models/index.ts +5 -2
- package/dist/esm/models/AssumeUserRequest.d.ts +0 -53
- package/dist/esm/models/AssumeUserRequest.js +0 -48
- package/dist/esm/models/AssumeUserResponse.d.ts +0 -47
- package/dist/esm/models/AssumeUserResponse.js +0 -44
- package/dist/models/AssumeUserRequest.d.ts +0 -53
- package/dist/models/AssumeUserRequest.js +0 -56
- package/dist/models/AssumeUserResponse.d.ts +0 -47
- package/dist/models/AssumeUserResponse.js +0 -52
- package/src/models/AssumeUserRequest.ts +0 -92
- package/src/models/AssumeUserResponse.ts +0 -83
package/package.json
CHANGED
package/src/apis/AuthApi.ts
CHANGED
|
@@ -15,8 +15,6 @@
|
|
|
15
15
|
|
|
16
16
|
import * as runtime from '../runtime';
|
|
17
17
|
import type {
|
|
18
|
-
AssumeUserRequest,
|
|
19
|
-
AssumeUserResponse,
|
|
20
18
|
CreatePasswordUserRequest,
|
|
21
19
|
EmailSentResponse,
|
|
22
20
|
EmailVerificationRequest,
|
|
@@ -28,10 +26,6 @@ import type {
|
|
|
28
26
|
UserResponse,
|
|
29
27
|
} from '../models/index';
|
|
30
28
|
import {
|
|
31
|
-
AssumeUserRequestFromJSON,
|
|
32
|
-
AssumeUserRequestToJSON,
|
|
33
|
-
AssumeUserResponseFromJSON,
|
|
34
|
-
AssumeUserResponseToJSON,
|
|
35
29
|
CreatePasswordUserRequestFromJSON,
|
|
36
30
|
CreatePasswordUserRequestToJSON,
|
|
37
31
|
EmailSentResponseFromJSON,
|
|
@@ -52,11 +46,6 @@ import {
|
|
|
52
46
|
UserResponseToJSON,
|
|
53
47
|
} from '../models/index';
|
|
54
48
|
|
|
55
|
-
export interface AssumeUserOperationRequest {
|
|
56
|
-
xAdminApiKey: string;
|
|
57
|
-
assumeUserRequest: AssumeUserRequest;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
49
|
export interface CreatePasswordUserOperationRequest {
|
|
61
50
|
createPasswordUserRequest: CreatePasswordUserRequest;
|
|
62
51
|
}
|
|
@@ -108,23 +97,6 @@ export interface SendPwResetEmailRequest {
|
|
|
108
97
|
* @interface AuthApiInterface
|
|
109
98
|
*/
|
|
110
99
|
export interface AuthApiInterface {
|
|
111
|
-
/**
|
|
112
|
-
* Generate a UAT for a given user/tenant pair. Authenticated via static ADMIN_API_KEY. Intended for worker service to obtain identity credentials for user-aware API operations. Validates that the user is a member of the requested tenant before minting the token.
|
|
113
|
-
* @summary Assume User Identity Handler
|
|
114
|
-
* @param {string} xAdminApiKey
|
|
115
|
-
* @param {AssumeUserRequest} assumeUserRequest
|
|
116
|
-
* @param {*} [options] Override http request option.
|
|
117
|
-
* @throws {RequiredError}
|
|
118
|
-
* @memberof AuthApiInterface
|
|
119
|
-
*/
|
|
120
|
-
assumeUserRaw(requestParameters: AssumeUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssumeUserResponse>>;
|
|
121
|
-
|
|
122
|
-
/**
|
|
123
|
-
* Generate a UAT for a given user/tenant pair. Authenticated via static ADMIN_API_KEY. Intended for worker service to obtain identity credentials for user-aware API operations. Validates that the user is a member of the requested tenant before minting the token.
|
|
124
|
-
* Assume User Identity Handler
|
|
125
|
-
*/
|
|
126
|
-
assumeUser(requestParameters: AssumeUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssumeUserResponse>;
|
|
127
|
-
|
|
128
100
|
/**
|
|
129
101
|
*
|
|
130
102
|
* @summary Create Password User Handler
|
|
@@ -296,58 +268,6 @@ export interface AuthApiInterface {
|
|
|
296
268
|
*/
|
|
297
269
|
export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
|
|
298
270
|
|
|
299
|
-
/**
|
|
300
|
-
* Generate a UAT for a given user/tenant pair. Authenticated via static ADMIN_API_KEY. Intended for worker service to obtain identity credentials for user-aware API operations. Validates that the user is a member of the requested tenant before minting the token.
|
|
301
|
-
* Assume User Identity Handler
|
|
302
|
-
*/
|
|
303
|
-
async assumeUserRaw(requestParameters: AssumeUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssumeUserResponse>> {
|
|
304
|
-
if (requestParameters['xAdminApiKey'] == null) {
|
|
305
|
-
throw new runtime.RequiredError(
|
|
306
|
-
'xAdminApiKey',
|
|
307
|
-
'Required parameter "xAdminApiKey" was null or undefined when calling assumeUser().'
|
|
308
|
-
);
|
|
309
|
-
}
|
|
310
|
-
|
|
311
|
-
if (requestParameters['assumeUserRequest'] == null) {
|
|
312
|
-
throw new runtime.RequiredError(
|
|
313
|
-
'assumeUserRequest',
|
|
314
|
-
'Required parameter "assumeUserRequest" was null or undefined when calling assumeUser().'
|
|
315
|
-
);
|
|
316
|
-
}
|
|
317
|
-
|
|
318
|
-
const queryParameters: any = {};
|
|
319
|
-
|
|
320
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
321
|
-
|
|
322
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
323
|
-
|
|
324
|
-
if (requestParameters['xAdminApiKey'] != null) {
|
|
325
|
-
headerParameters['x-admin-api-key'] = String(requestParameters['xAdminApiKey']);
|
|
326
|
-
}
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
let urlPath = `/v1/auth/assume_user`;
|
|
330
|
-
|
|
331
|
-
const response = await this.request({
|
|
332
|
-
path: urlPath,
|
|
333
|
-
method: 'POST',
|
|
334
|
-
headers: headerParameters,
|
|
335
|
-
query: queryParameters,
|
|
336
|
-
body: AssumeUserRequestToJSON(requestParameters['assumeUserRequest']),
|
|
337
|
-
}, initOverrides);
|
|
338
|
-
|
|
339
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => AssumeUserResponseFromJSON(jsonValue));
|
|
340
|
-
}
|
|
341
|
-
|
|
342
|
-
/**
|
|
343
|
-
* Generate a UAT for a given user/tenant pair. Authenticated via static ADMIN_API_KEY. Intended for worker service to obtain identity credentials for user-aware API operations. Validates that the user is a member of the requested tenant before minting the token.
|
|
344
|
-
* Assume User Identity Handler
|
|
345
|
-
*/
|
|
346
|
-
async assumeUser(requestParameters: AssumeUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssumeUserResponse> {
|
|
347
|
-
const response = await this.assumeUserRaw(requestParameters, initOverrides);
|
|
348
|
-
return await response.value();
|
|
349
|
-
}
|
|
350
|
-
|
|
351
271
|
/**
|
|
352
272
|
* Create Password User Handler
|
|
353
273
|
*/
|
package/src/apis/DocumentsApi.ts
CHANGED
|
@@ -63,7 +63,7 @@ export interface IngestDocumentRequest {
|
|
|
63
63
|
}
|
|
64
64
|
|
|
65
65
|
export interface ListDocumentsRequest {
|
|
66
|
-
|
|
66
|
+
parentFolderId?: string;
|
|
67
67
|
sortOrder?: PathOrder;
|
|
68
68
|
limit?: number;
|
|
69
69
|
offset?: number;
|
|
@@ -154,9 +154,9 @@ export interface DocumentsApiInterface {
|
|
|
154
154
|
ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
|
|
155
155
|
|
|
156
156
|
/**
|
|
157
|
-
* List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If
|
|
157
|
+
* List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_folder_id is not provided, lists documents in the root folder.
|
|
158
158
|
* @summary List Documents Handler
|
|
159
|
-
* @param {string} [
|
|
159
|
+
* @param {string} [parentFolderId] Parent folder ID (defaults to root)
|
|
160
160
|
* @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
161
161
|
* @param {number} [limit] Number of items per page
|
|
162
162
|
* @param {number} [offset] Number of items to skip
|
|
@@ -168,13 +168,13 @@ export interface DocumentsApiInterface {
|
|
|
168
168
|
listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>>;
|
|
169
169
|
|
|
170
170
|
/**
|
|
171
|
-
* List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If
|
|
171
|
+
* List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_folder_id is not provided, lists documents in the root folder.
|
|
172
172
|
* List Documents Handler
|
|
173
173
|
*/
|
|
174
174
|
listDocuments(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse>;
|
|
175
175
|
|
|
176
176
|
/**
|
|
177
|
-
* Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `
|
|
177
|
+
* Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_folder_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
|
|
178
178
|
* @summary Update Document Handler
|
|
179
179
|
* @param {string} documentId
|
|
180
180
|
* @param {UpdateDocumentRequest} updateDocumentRequest
|
|
@@ -186,7 +186,7 @@ export interface DocumentsApiInterface {
|
|
|
186
186
|
updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
|
|
187
187
|
|
|
188
188
|
/**
|
|
189
|
-
* Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `
|
|
189
|
+
* Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_folder_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
|
|
190
190
|
* Update Document Handler
|
|
191
191
|
*/
|
|
192
192
|
updateDocument(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
|
|
@@ -391,14 +391,14 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
|
|
|
391
391
|
}
|
|
392
392
|
|
|
393
393
|
/**
|
|
394
|
-
* List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If
|
|
394
|
+
* List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_folder_id is not provided, lists documents in the root folder.
|
|
395
395
|
* List Documents Handler
|
|
396
396
|
*/
|
|
397
397
|
async listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>> {
|
|
398
398
|
const queryParameters: any = {};
|
|
399
399
|
|
|
400
|
-
if (requestParameters['
|
|
401
|
-
queryParameters['
|
|
400
|
+
if (requestParameters['parentFolderId'] != null) {
|
|
401
|
+
queryParameters['parent_folder_id'] = requestParameters['parentFolderId'];
|
|
402
402
|
}
|
|
403
403
|
|
|
404
404
|
if (requestParameters['sortOrder'] != null) {
|
|
@@ -429,7 +429,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
|
|
|
429
429
|
}
|
|
430
430
|
|
|
431
431
|
/**
|
|
432
|
-
* List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If
|
|
432
|
+
* List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_folder_id is not provided, lists documents in the root folder.
|
|
433
433
|
* List Documents Handler
|
|
434
434
|
*/
|
|
435
435
|
async listDocuments(requestParameters: ListDocumentsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse> {
|
|
@@ -438,7 +438,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
|
|
|
438
438
|
}
|
|
439
439
|
|
|
440
440
|
/**
|
|
441
|
-
* Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `
|
|
441
|
+
* Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_folder_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
|
|
442
442
|
* Update Document Handler
|
|
443
443
|
*/
|
|
444
444
|
async updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>> {
|
|
@@ -478,7 +478,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
|
|
|
478
478
|
}
|
|
479
479
|
|
|
480
480
|
/**
|
|
481
|
-
* Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `
|
|
481
|
+
* Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_folder_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
|
|
482
482
|
* Update Document Handler
|
|
483
483
|
*/
|
|
484
484
|
async updateDocument(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse> {
|
package/src/apis/FoldersApi.ts
CHANGED
|
@@ -65,7 +65,7 @@ export interface ListFolderContentsRequest {
|
|
|
65
65
|
}
|
|
66
66
|
|
|
67
67
|
export interface ListFoldersRequest {
|
|
68
|
-
|
|
68
|
+
parentFolderId?: string;
|
|
69
69
|
sortOrder?: PathOrder;
|
|
70
70
|
limit?: number;
|
|
71
71
|
offset?: number;
|
|
@@ -158,9 +158,9 @@ export interface FoldersApiInterface {
|
|
|
158
158
|
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
|
|
159
159
|
|
|
160
160
|
/**
|
|
161
|
-
* List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If
|
|
161
|
+
* List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_folder_id is not provided, lists folders in the root folder.
|
|
162
162
|
* @summary List Folders Handler
|
|
163
|
-
* @param {string} [
|
|
163
|
+
* @param {string} [parentFolderId] Parent folder ID (defaults to root)
|
|
164
164
|
* @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
165
165
|
* @param {number} [limit] Number of items per page
|
|
166
166
|
* @param {number} [offset] Number of items to skip
|
|
@@ -172,13 +172,13 @@ export interface FoldersApiInterface {
|
|
|
172
172
|
listFoldersRaw(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderResponse>>;
|
|
173
173
|
|
|
174
174
|
/**
|
|
175
|
-
* List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If
|
|
175
|
+
* List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_folder_id is not provided, lists folders in the root folder.
|
|
176
176
|
* List Folders Handler
|
|
177
177
|
*/
|
|
178
178
|
listFolders(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
|
|
179
179
|
|
|
180
180
|
/**
|
|
181
|
-
* Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `
|
|
181
|
+
* Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_folder_id` field. Both can be done in a single request.
|
|
182
182
|
* @summary Update Folder Handler
|
|
183
183
|
* @param {string} folderId
|
|
184
184
|
* @param {UpdateFolderRequest} updateFolderRequest
|
|
@@ -190,7 +190,7 @@ export interface FoldersApiInterface {
|
|
|
190
190
|
updateFolderRaw(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>>;
|
|
191
191
|
|
|
192
192
|
/**
|
|
193
|
-
* Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `
|
|
193
|
+
* Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_folder_id` field. Both can be done in a single request.
|
|
194
194
|
* Update Folder Handler
|
|
195
195
|
*/
|
|
196
196
|
updateFolder(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
|
|
@@ -376,14 +376,14 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
376
376
|
}
|
|
377
377
|
|
|
378
378
|
/**
|
|
379
|
-
* List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If
|
|
379
|
+
* List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_folder_id is not provided, lists folders in the root folder.
|
|
380
380
|
* List Folders Handler
|
|
381
381
|
*/
|
|
382
382
|
async listFoldersRaw(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderResponse>> {
|
|
383
383
|
const queryParameters: any = {};
|
|
384
384
|
|
|
385
|
-
if (requestParameters['
|
|
386
|
-
queryParameters['
|
|
385
|
+
if (requestParameters['parentFolderId'] != null) {
|
|
386
|
+
queryParameters['parent_folder_id'] = requestParameters['parentFolderId'];
|
|
387
387
|
}
|
|
388
388
|
|
|
389
389
|
if (requestParameters['sortOrder'] != null) {
|
|
@@ -414,7 +414,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
414
414
|
}
|
|
415
415
|
|
|
416
416
|
/**
|
|
417
|
-
* List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If
|
|
417
|
+
* List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_folder_id is not provided, lists folders in the root folder.
|
|
418
418
|
* List Folders Handler
|
|
419
419
|
*/
|
|
420
420
|
async listFolders(requestParameters: ListFoldersRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse> {
|
|
@@ -423,7 +423,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
423
423
|
}
|
|
424
424
|
|
|
425
425
|
/**
|
|
426
|
-
* Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `
|
|
426
|
+
* Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_folder_id` field. Both can be done in a single request.
|
|
427
427
|
* Update Folder Handler
|
|
428
428
|
*/
|
|
429
429
|
async updateFolderRaw(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>> {
|
|
@@ -463,7 +463,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
463
463
|
}
|
|
464
464
|
|
|
465
465
|
/**
|
|
466
|
-
* Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `
|
|
466
|
+
* Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_folder_id` field. Both can be done in a single request.
|
|
467
467
|
* Update Folder Handler
|
|
468
468
|
*/
|
|
469
469
|
async updateFolder(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse> {
|
|
@@ -0,0 +1,249 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.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 * as runtime from '../runtime';
|
|
17
|
+
import type {
|
|
18
|
+
HTTPValidationError,
|
|
19
|
+
PaginatedResponseWorkflowSummaryResponse,
|
|
20
|
+
WorkflowAction,
|
|
21
|
+
WorkflowActionResponse,
|
|
22
|
+
WorkflowDetailResponse,
|
|
23
|
+
} from '../models/index';
|
|
24
|
+
import {
|
|
25
|
+
HTTPValidationErrorFromJSON,
|
|
26
|
+
HTTPValidationErrorToJSON,
|
|
27
|
+
PaginatedResponseWorkflowSummaryResponseFromJSON,
|
|
28
|
+
PaginatedResponseWorkflowSummaryResponseToJSON,
|
|
29
|
+
WorkflowActionFromJSON,
|
|
30
|
+
WorkflowActionToJSON,
|
|
31
|
+
WorkflowActionResponseFromJSON,
|
|
32
|
+
WorkflowActionResponseToJSON,
|
|
33
|
+
WorkflowDetailResponseFromJSON,
|
|
34
|
+
WorkflowDetailResponseToJSON,
|
|
35
|
+
} from '../models/index';
|
|
36
|
+
|
|
37
|
+
export interface GetWorkflowRequest {
|
|
38
|
+
workflowId: string;
|
|
39
|
+
ksUat?: string;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export interface ListWorkflowsRequest {
|
|
43
|
+
limit?: number;
|
|
44
|
+
offset?: number;
|
|
45
|
+
ksUat?: string;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
export interface WorkflowActionRequest {
|
|
49
|
+
workflowId: string;
|
|
50
|
+
action: WorkflowAction;
|
|
51
|
+
ksUat?: string;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* WorkflowsApi - interface
|
|
56
|
+
*
|
|
57
|
+
* @export
|
|
58
|
+
* @interface WorkflowsApiInterface
|
|
59
|
+
*/
|
|
60
|
+
export interface WorkflowsApiInterface {
|
|
61
|
+
/**
|
|
62
|
+
* Get single workflow detail with live Temporal status.
|
|
63
|
+
* @summary Get Workflow Handler
|
|
64
|
+
* @param {string} workflowId
|
|
65
|
+
* @param {string} [ksUat]
|
|
66
|
+
* @param {*} [options] Override http request option.
|
|
67
|
+
* @throws {RequiredError}
|
|
68
|
+
* @memberof WorkflowsApiInterface
|
|
69
|
+
*/
|
|
70
|
+
getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* Get single workflow detail with live Temporal status.
|
|
74
|
+
* Get Workflow Handler
|
|
75
|
+
*/
|
|
76
|
+
getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* List all workflows for the current tenant (paginated, DB-backed).
|
|
80
|
+
* @summary List Workflows Handler
|
|
81
|
+
* @param {number} [limit] Number of items per page
|
|
82
|
+
* @param {number} [offset] Number of items to skip
|
|
83
|
+
* @param {string} [ksUat]
|
|
84
|
+
* @param {*} [options] Override http request option.
|
|
85
|
+
* @throws {RequiredError}
|
|
86
|
+
* @memberof WorkflowsApiInterface
|
|
87
|
+
*/
|
|
88
|
+
listWorkflowsRaw(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* List all workflows for the current tenant (paginated, DB-backed).
|
|
92
|
+
* List Workflows Handler
|
|
93
|
+
*/
|
|
94
|
+
listWorkflows(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* Cancel or rerun a workflow (OWNER/ADMIN only).
|
|
98
|
+
* @summary Workflow Action Handler
|
|
99
|
+
* @param {string} workflowId
|
|
100
|
+
* @param {WorkflowAction} action Action to perform
|
|
101
|
+
* @param {string} [ksUat]
|
|
102
|
+
* @param {*} [options] Override http request option.
|
|
103
|
+
* @throws {RequiredError}
|
|
104
|
+
* @memberof WorkflowsApiInterface
|
|
105
|
+
*/
|
|
106
|
+
workflowActionRaw(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* Cancel or rerun a workflow (OWNER/ADMIN only).
|
|
110
|
+
* Workflow Action Handler
|
|
111
|
+
*/
|
|
112
|
+
workflowAction(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
|
|
113
|
+
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
*
|
|
118
|
+
*/
|
|
119
|
+
export class WorkflowsApi extends runtime.BaseAPI implements WorkflowsApiInterface {
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* Get single workflow detail with live Temporal status.
|
|
123
|
+
* Get Workflow Handler
|
|
124
|
+
*/
|
|
125
|
+
async getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>> {
|
|
126
|
+
if (requestParameters['workflowId'] == null) {
|
|
127
|
+
throw new runtime.RequiredError(
|
|
128
|
+
'workflowId',
|
|
129
|
+
'Required parameter "workflowId" was null or undefined when calling getWorkflow().'
|
|
130
|
+
);
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
const queryParameters: any = {};
|
|
134
|
+
|
|
135
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
let urlPath = `/v1/workflows/{workflow_id}`;
|
|
139
|
+
urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
|
|
140
|
+
|
|
141
|
+
const response = await this.request({
|
|
142
|
+
path: urlPath,
|
|
143
|
+
method: 'GET',
|
|
144
|
+
headers: headerParameters,
|
|
145
|
+
query: queryParameters,
|
|
146
|
+
}, initOverrides);
|
|
147
|
+
|
|
148
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowDetailResponseFromJSON(jsonValue));
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* Get single workflow detail with live Temporal status.
|
|
153
|
+
* Get Workflow Handler
|
|
154
|
+
*/
|
|
155
|
+
async getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse> {
|
|
156
|
+
const response = await this.getWorkflowRaw(requestParameters, initOverrides);
|
|
157
|
+
return await response.value();
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* List all workflows for the current tenant (paginated, DB-backed).
|
|
162
|
+
* List Workflows Handler
|
|
163
|
+
*/
|
|
164
|
+
async listWorkflowsRaw(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>> {
|
|
165
|
+
const queryParameters: any = {};
|
|
166
|
+
|
|
167
|
+
if (requestParameters['limit'] != null) {
|
|
168
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
if (requestParameters['offset'] != null) {
|
|
172
|
+
queryParameters['offset'] = requestParameters['offset'];
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
let urlPath = `/v1/workflows`;
|
|
179
|
+
|
|
180
|
+
const response = await this.request({
|
|
181
|
+
path: urlPath,
|
|
182
|
+
method: 'GET',
|
|
183
|
+
headers: headerParameters,
|
|
184
|
+
query: queryParameters,
|
|
185
|
+
}, initOverrides);
|
|
186
|
+
|
|
187
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseWorkflowSummaryResponseFromJSON(jsonValue));
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
/**
|
|
191
|
+
* List all workflows for the current tenant (paginated, DB-backed).
|
|
192
|
+
* List Workflows Handler
|
|
193
|
+
*/
|
|
194
|
+
async listWorkflows(requestParameters: ListWorkflowsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse> {
|
|
195
|
+
const response = await this.listWorkflowsRaw(requestParameters, initOverrides);
|
|
196
|
+
return await response.value();
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* Cancel or rerun a workflow (OWNER/ADMIN only).
|
|
201
|
+
* Workflow Action Handler
|
|
202
|
+
*/
|
|
203
|
+
async workflowActionRaw(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>> {
|
|
204
|
+
if (requestParameters['workflowId'] == null) {
|
|
205
|
+
throw new runtime.RequiredError(
|
|
206
|
+
'workflowId',
|
|
207
|
+
'Required parameter "workflowId" was null or undefined when calling workflowAction().'
|
|
208
|
+
);
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
if (requestParameters['action'] == null) {
|
|
212
|
+
throw new runtime.RequiredError(
|
|
213
|
+
'action',
|
|
214
|
+
'Required parameter "action" was null or undefined when calling workflowAction().'
|
|
215
|
+
);
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
const queryParameters: any = {};
|
|
219
|
+
|
|
220
|
+
if (requestParameters['action'] != null) {
|
|
221
|
+
queryParameters['action'] = requestParameters['action'];
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
let urlPath = `/v1/workflows/{workflow_id}`;
|
|
228
|
+
urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
|
|
229
|
+
|
|
230
|
+
const response = await this.request({
|
|
231
|
+
path: urlPath,
|
|
232
|
+
method: 'POST',
|
|
233
|
+
headers: headerParameters,
|
|
234
|
+
query: queryParameters,
|
|
235
|
+
}, initOverrides);
|
|
236
|
+
|
|
237
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowActionResponseFromJSON(jsonValue));
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
/**
|
|
241
|
+
* Cancel or rerun a workflow (OWNER/ADMIN only).
|
|
242
|
+
* Workflow Action Handler
|
|
243
|
+
*/
|
|
244
|
+
async workflowAction(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse> {
|
|
245
|
+
const response = await this.workflowActionRaw(requestParameters, initOverrides);
|
|
246
|
+
return await response.value();
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
}
|
package/src/apis/index.ts
CHANGED
|
@@ -41,11 +41,11 @@ export interface CreateDocumentRequest {
|
|
|
41
41
|
*/
|
|
42
42
|
name: string;
|
|
43
43
|
/**
|
|
44
|
-
* Parent folder
|
|
44
|
+
* Parent folder ID
|
|
45
45
|
* @type {string}
|
|
46
46
|
* @memberof CreateDocumentRequest
|
|
47
47
|
*/
|
|
48
|
-
|
|
48
|
+
parentFolderId: string;
|
|
49
49
|
/**
|
|
50
50
|
* Type of document (PDF, UNKNOWN, etc.)
|
|
51
51
|
* @type {DocumentType}
|
|
@@ -67,7 +67,7 @@ export interface CreateDocumentRequest {
|
|
|
67
67
|
*/
|
|
68
68
|
export function instanceOfCreateDocumentRequest(value: object): value is CreateDocumentRequest {
|
|
69
69
|
if (!('name' in value) || value['name'] === undefined) return false;
|
|
70
|
-
if (!('
|
|
70
|
+
if (!('parentFolderId' in value) || value['parentFolderId'] === undefined) return false;
|
|
71
71
|
if (!('documentType' in value) || value['documentType'] === undefined) return false;
|
|
72
72
|
if (!('documentOrigin' in value) || value['documentOrigin'] === undefined) return false;
|
|
73
73
|
return true;
|
|
@@ -84,7 +84,7 @@ export function CreateDocumentRequestFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
84
84
|
return {
|
|
85
85
|
|
|
86
86
|
'name': json['name'],
|
|
87
|
-
'
|
|
87
|
+
'parentFolderId': json['parent_folder_id'],
|
|
88
88
|
'documentType': DocumentTypeFromJSON(json['document_type']),
|
|
89
89
|
'documentOrigin': DocumentOriginFromJSON(json['document_origin']),
|
|
90
90
|
};
|
|
@@ -102,7 +102,7 @@ export function CreateDocumentRequestToJSONTyped(value?: CreateDocumentRequest |
|
|
|
102
102
|
return {
|
|
103
103
|
|
|
104
104
|
'name': value['name'],
|
|
105
|
-
'
|
|
105
|
+
'parent_folder_id': value['parentFolderId'],
|
|
106
106
|
'document_type': DocumentTypeToJSON(value['documentType']),
|
|
107
107
|
'document_origin': DocumentOriginToJSON(value['documentOrigin']),
|
|
108
108
|
};
|
|
@@ -26,11 +26,11 @@ export interface CreateFolderRequest {
|
|
|
26
26
|
*/
|
|
27
27
|
name: string;
|
|
28
28
|
/**
|
|
29
|
-
* Parent folder
|
|
29
|
+
* Parent folder ID
|
|
30
30
|
* @type {string}
|
|
31
31
|
* @memberof CreateFolderRequest
|
|
32
32
|
*/
|
|
33
|
-
|
|
33
|
+
parentFolderId: string;
|
|
34
34
|
}
|
|
35
35
|
|
|
36
36
|
/**
|
|
@@ -38,7 +38,7 @@ export interface CreateFolderRequest {
|
|
|
38
38
|
*/
|
|
39
39
|
export function instanceOfCreateFolderRequest(value: object): value is CreateFolderRequest {
|
|
40
40
|
if (!('name' in value) || value['name'] === undefined) return false;
|
|
41
|
-
if (!('
|
|
41
|
+
if (!('parentFolderId' in value) || value['parentFolderId'] === undefined) return false;
|
|
42
42
|
return true;
|
|
43
43
|
}
|
|
44
44
|
|
|
@@ -53,7 +53,7 @@ export function CreateFolderRequestFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
53
53
|
return {
|
|
54
54
|
|
|
55
55
|
'name': json['name'],
|
|
56
|
-
'
|
|
56
|
+
'parentFolderId': json['parent_folder_id'],
|
|
57
57
|
};
|
|
58
58
|
}
|
|
59
59
|
|
|
@@ -69,7 +69,7 @@ export function CreateFolderRequestToJSONTyped(value?: CreateFolderRequest | nul
|
|
|
69
69
|
return {
|
|
70
70
|
|
|
71
71
|
'name': value['name'],
|
|
72
|
-
'
|
|
72
|
+
'parent_folder_id': value['parentFolderId'],
|
|
73
73
|
};
|
|
74
74
|
}
|
|
75
75
|
|