@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.
Files changed (103) hide show
  1. package/.openapi-generator/FILES +6 -2
  2. package/README.md +2 -2
  3. package/dist/apis/AuthApi.d.ts +1 -30
  4. package/dist/apis/AuthApi.js +0 -39
  5. package/dist/apis/DocumentsApi.d.ts +10 -10
  6. package/dist/apis/DocumentsApi.js +6 -6
  7. package/dist/apis/FoldersApi.d.ts +10 -10
  8. package/dist/apis/FoldersApi.js +6 -6
  9. package/dist/apis/WorkflowsApi.d.ts +117 -0
  10. package/dist/apis/WorkflowsApi.js +137 -0
  11. package/dist/apis/index.d.ts +1 -0
  12. package/dist/apis/index.js +1 -0
  13. package/dist/esm/apis/AuthApi.d.ts +1 -30
  14. package/dist/esm/apis/AuthApi.js +1 -40
  15. package/dist/esm/apis/DocumentsApi.d.ts +10 -10
  16. package/dist/esm/apis/DocumentsApi.js +6 -6
  17. package/dist/esm/apis/FoldersApi.d.ts +10 -10
  18. package/dist/esm/apis/FoldersApi.js +6 -6
  19. package/dist/esm/apis/WorkflowsApi.d.ts +117 -0
  20. package/dist/esm/apis/WorkflowsApi.js +133 -0
  21. package/dist/esm/apis/index.d.ts +1 -0
  22. package/dist/esm/apis/index.js +1 -0
  23. package/dist/esm/models/CreateDocumentRequest.d.ts +2 -2
  24. package/dist/esm/models/CreateDocumentRequest.js +3 -3
  25. package/dist/esm/models/CreateFolderRequest.d.ts +2 -2
  26. package/dist/esm/models/CreateFolderRequest.js +3 -3
  27. package/dist/esm/models/DocumentResponse.d.ts +2 -2
  28. package/dist/esm/models/DocumentResponse.js +3 -3
  29. package/dist/esm/models/FolderResponse.d.ts +2 -2
  30. package/dist/esm/models/FolderResponse.js +3 -3
  31. package/dist/esm/models/PaginatedResponseWorkflowSummaryResponse.d.ts +66 -0
  32. package/dist/esm/models/PaginatedResponseWorkflowSummaryResponse.js +70 -0
  33. package/dist/esm/models/PipelineStatus.d.ts +1 -0
  34. package/dist/esm/models/PipelineStatus.js +2 -1
  35. package/dist/esm/models/UpdateDocumentRequest.d.ts +2 -2
  36. package/dist/esm/models/UpdateDocumentRequest.js +2 -2
  37. package/dist/esm/models/UpdateFolderRequest.d.ts +2 -2
  38. package/dist/esm/models/UpdateFolderRequest.js +2 -2
  39. package/dist/esm/models/WorkflowAction.d.ts +25 -0
  40. package/dist/esm/models/WorkflowAction.js +43 -0
  41. package/dist/esm/models/WorkflowActionResponse.d.ts +59 -0
  42. package/dist/esm/models/WorkflowActionResponse.js +52 -0
  43. package/dist/esm/models/WorkflowDetailResponse.d.ts +132 -0
  44. package/dist/esm/models/WorkflowDetailResponse.js +93 -0
  45. package/dist/esm/models/WorkflowSummaryResponse.d.ts +90 -0
  46. package/dist/esm/models/WorkflowSummaryResponse.js +69 -0
  47. package/dist/esm/models/index.d.ts +5 -2
  48. package/dist/esm/models/index.js +5 -2
  49. package/dist/models/CreateDocumentRequest.d.ts +2 -2
  50. package/dist/models/CreateDocumentRequest.js +3 -3
  51. package/dist/models/CreateFolderRequest.d.ts +2 -2
  52. package/dist/models/CreateFolderRequest.js +3 -3
  53. package/dist/models/DocumentResponse.d.ts +2 -2
  54. package/dist/models/DocumentResponse.js +3 -3
  55. package/dist/models/FolderResponse.d.ts +2 -2
  56. package/dist/models/FolderResponse.js +3 -3
  57. package/dist/models/PaginatedResponseWorkflowSummaryResponse.d.ts +66 -0
  58. package/dist/models/PaginatedResponseWorkflowSummaryResponse.js +78 -0
  59. package/dist/models/PipelineStatus.d.ts +1 -0
  60. package/dist/models/PipelineStatus.js +2 -1
  61. package/dist/models/UpdateDocumentRequest.d.ts +2 -2
  62. package/dist/models/UpdateDocumentRequest.js +2 -2
  63. package/dist/models/UpdateFolderRequest.d.ts +2 -2
  64. package/dist/models/UpdateFolderRequest.js +2 -2
  65. package/dist/models/WorkflowAction.d.ts +25 -0
  66. package/dist/models/WorkflowAction.js +51 -0
  67. package/dist/models/WorkflowActionResponse.d.ts +59 -0
  68. package/dist/models/WorkflowActionResponse.js +60 -0
  69. package/dist/models/WorkflowDetailResponse.d.ts +132 -0
  70. package/dist/models/WorkflowDetailResponse.js +101 -0
  71. package/dist/models/WorkflowSummaryResponse.d.ts +90 -0
  72. package/dist/models/WorkflowSummaryResponse.js +77 -0
  73. package/dist/models/index.d.ts +5 -2
  74. package/dist/models/index.js +5 -2
  75. package/package.json +1 -1
  76. package/src/apis/AuthApi.ts +0 -80
  77. package/src/apis/DocumentsApi.ts +12 -12
  78. package/src/apis/FoldersApi.ts +12 -12
  79. package/src/apis/WorkflowsApi.ts +249 -0
  80. package/src/apis/index.ts +1 -0
  81. package/src/models/CreateDocumentRequest.ts +5 -5
  82. package/src/models/CreateFolderRequest.ts +5 -5
  83. package/src/models/DocumentResponse.ts +5 -5
  84. package/src/models/FolderResponse.ts +5 -5
  85. package/src/models/PaginatedResponseWorkflowSummaryResponse.ts +130 -0
  86. package/src/models/PipelineStatus.ts +2 -1
  87. package/src/models/UpdateDocumentRequest.ts +4 -4
  88. package/src/models/UpdateFolderRequest.ts +4 -4
  89. package/src/models/WorkflowAction.ts +53 -0
  90. package/src/models/WorkflowActionResponse.ts +101 -0
  91. package/src/models/WorkflowDetailResponse.ts +215 -0
  92. package/src/models/WorkflowSummaryResponse.ts +154 -0
  93. package/src/models/index.ts +5 -2
  94. package/dist/esm/models/AssumeUserRequest.d.ts +0 -53
  95. package/dist/esm/models/AssumeUserRequest.js +0 -48
  96. package/dist/esm/models/AssumeUserResponse.d.ts +0 -47
  97. package/dist/esm/models/AssumeUserResponse.js +0 -44
  98. package/dist/models/AssumeUserRequest.d.ts +0 -53
  99. package/dist/models/AssumeUserRequest.js +0 -56
  100. package/dist/models/AssumeUserResponse.d.ts +0 -47
  101. package/dist/models/AssumeUserResponse.js +0 -52
  102. package/src/models/AssumeUserRequest.ts +0 -92
  103. package/src/models/AssumeUserResponse.ts +0 -83
@@ -10,11 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { AssumeUserRequest, AssumeUserResponse, CreatePasswordUserRequest, EmailSentResponse, EmailVerificationRequest, IdpType, PasswordResetRequest, PasswordResetWithTokenRequest, SignInRequest, UserResponse } from '../models/index';
14
- export interface AssumeUserOperationRequest {
15
- xAdminApiKey: string;
16
- assumeUserRequest: AssumeUserRequest;
17
- }
13
+ import type { CreatePasswordUserRequest, EmailSentResponse, EmailVerificationRequest, IdpType, PasswordResetRequest, PasswordResetWithTokenRequest, SignInRequest, UserResponse } from '../models/index';
18
14
  export interface CreatePasswordUserOperationRequest {
19
15
  createPasswordUserRequest: CreatePasswordUserRequest;
20
16
  }
@@ -57,21 +53,6 @@ export interface SendPwResetEmailRequest {
57
53
  * @interface AuthApiInterface
58
54
  */
59
55
  export interface AuthApiInterface {
60
- /**
61
- * 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.
62
- * @summary Assume User Identity Handler
63
- * @param {string} xAdminApiKey
64
- * @param {AssumeUserRequest} assumeUserRequest
65
- * @param {*} [options] Override http request option.
66
- * @throws {RequiredError}
67
- * @memberof AuthApiInterface
68
- */
69
- assumeUserRaw(requestParameters: AssumeUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssumeUserResponse>>;
70
- /**
71
- * 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.
72
- * Assume User Identity Handler
73
- */
74
- assumeUser(requestParameters: AssumeUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssumeUserResponse>;
75
56
  /**
76
57
  *
77
58
  * @summary Create Password User Handler
@@ -221,16 +202,6 @@ export interface AuthApiInterface {
221
202
  *
222
203
  */
223
204
  export declare class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
224
- /**
225
- * 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.
226
- * Assume User Identity Handler
227
- */
228
- assumeUserRaw(requestParameters: AssumeUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssumeUserResponse>>;
229
- /**
230
- * 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.
231
- * Assume User Identity Handler
232
- */
233
- assumeUser(requestParameters: AssumeUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssumeUserResponse>;
234
205
  /**
235
206
  * Create Password User Handler
236
207
  */
@@ -21,50 +21,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { AssumeUserRequestToJSON, AssumeUserResponseFromJSON, CreatePasswordUserRequestToJSON, EmailSentResponseFromJSON, EmailVerificationRequestToJSON, PasswordResetRequestToJSON, PasswordResetWithTokenRequestToJSON, SignInRequestToJSON, UserResponseFromJSON, } from '../models/index';
24
+ import { CreatePasswordUserRequestToJSON, EmailSentResponseFromJSON, EmailVerificationRequestToJSON, PasswordResetRequestToJSON, PasswordResetWithTokenRequestToJSON, SignInRequestToJSON, UserResponseFromJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
28
28
  export class AuthApi extends runtime.BaseAPI {
29
- /**
30
- * 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.
31
- * Assume User Identity Handler
32
- */
33
- assumeUserRaw(requestParameters, initOverrides) {
34
- return __awaiter(this, void 0, void 0, function* () {
35
- if (requestParameters['xAdminApiKey'] == null) {
36
- throw new runtime.RequiredError('xAdminApiKey', 'Required parameter "xAdminApiKey" was null or undefined when calling assumeUser().');
37
- }
38
- if (requestParameters['assumeUserRequest'] == null) {
39
- throw new runtime.RequiredError('assumeUserRequest', 'Required parameter "assumeUserRequest" was null or undefined when calling assumeUser().');
40
- }
41
- const queryParameters = {};
42
- const headerParameters = {};
43
- headerParameters['Content-Type'] = 'application/json';
44
- if (requestParameters['xAdminApiKey'] != null) {
45
- headerParameters['x-admin-api-key'] = String(requestParameters['xAdminApiKey']);
46
- }
47
- let urlPath = `/v1/auth/assume_user`;
48
- const response = yield this.request({
49
- path: urlPath,
50
- method: 'POST',
51
- headers: headerParameters,
52
- query: queryParameters,
53
- body: AssumeUserRequestToJSON(requestParameters['assumeUserRequest']),
54
- }, initOverrides);
55
- return new runtime.JSONApiResponse(response, (jsonValue) => AssumeUserResponseFromJSON(jsonValue));
56
- });
57
- }
58
- /**
59
- * 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.
60
- * Assume User Identity Handler
61
- */
62
- assumeUser(requestParameters, initOverrides) {
63
- return __awaiter(this, void 0, void 0, function* () {
64
- const response = yield this.assumeUserRaw(requestParameters, initOverrides);
65
- return yield response.value();
66
- });
67
- }
68
29
  /**
69
30
  * Create Password User Handler
70
31
  */
@@ -30,7 +30,7 @@ export interface IngestDocumentRequest {
30
30
  name?: string;
31
31
  }
32
32
  export interface ListDocumentsRequest {
33
- parentId?: string;
33
+ parentFolderId?: string;
34
34
  sortOrder?: PathOrder;
35
35
  limit?: number;
36
36
  offset?: number;
@@ -111,9 +111,9 @@ export interface DocumentsApiInterface {
111
111
  */
112
112
  ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
113
113
  /**
114
- * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
114
+ * 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.
115
115
  * @summary List Documents Handler
116
- * @param {string} [parentId] Parent folder PathPart ID (defaults to root)
116
+ * @param {string} [parentFolderId] Parent folder ID (defaults to root)
117
117
  * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
118
118
  * @param {number} [limit] Number of items per page
119
119
  * @param {number} [offset] Number of items to skip
@@ -124,12 +124,12 @@ export interface DocumentsApiInterface {
124
124
  */
125
125
  listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>>;
126
126
  /**
127
- * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
127
+ * 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.
128
128
  * List Documents Handler
129
129
  */
130
130
  listDocuments(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse>;
131
131
  /**
132
- * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
132
+ * 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.
133
133
  * @summary Update Document Handler
134
134
  * @param {string} documentId
135
135
  * @param {UpdateDocumentRequest} updateDocumentRequest
@@ -140,7 +140,7 @@ export interface DocumentsApiInterface {
140
140
  */
141
141
  updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
142
142
  /**
143
- * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
143
+ * 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.
144
144
  * Update Document Handler
145
145
  */
146
146
  updateDocument(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
@@ -190,22 +190,22 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
190
190
  */
191
191
  ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
192
192
  /**
193
- * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
193
+ * 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.
194
194
  * List Documents Handler
195
195
  */
196
196
  listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>>;
197
197
  /**
198
- * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
198
+ * 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.
199
199
  * List Documents Handler
200
200
  */
201
201
  listDocuments(requestParameters?: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse>;
202
202
  /**
203
- * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
203
+ * 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.
204
204
  * Update Document Handler
205
205
  */
206
206
  updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
207
207
  /**
208
- * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
208
+ * 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.
209
209
  * Update Document Handler
210
210
  */
211
211
  updateDocument(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
@@ -182,14 +182,14 @@ export class DocumentsApi extends runtime.BaseAPI {
182
182
  });
183
183
  }
184
184
  /**
185
- * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
185
+ * 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.
186
186
  * List Documents Handler
187
187
  */
188
188
  listDocumentsRaw(requestParameters, initOverrides) {
189
189
  return __awaiter(this, void 0, void 0, function* () {
190
190
  const queryParameters = {};
191
- if (requestParameters['parentId'] != null) {
192
- queryParameters['parent_id'] = requestParameters['parentId'];
191
+ if (requestParameters['parentFolderId'] != null) {
192
+ queryParameters['parent_folder_id'] = requestParameters['parentFolderId'];
193
193
  }
194
194
  if (requestParameters['sortOrder'] != null) {
195
195
  queryParameters['sort_order'] = requestParameters['sortOrder'];
@@ -212,7 +212,7 @@ export class DocumentsApi extends runtime.BaseAPI {
212
212
  });
213
213
  }
214
214
  /**
215
- * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
215
+ * 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.
216
216
  * List Documents Handler
217
217
  */
218
218
  listDocuments() {
@@ -222,7 +222,7 @@ export class DocumentsApi extends runtime.BaseAPI {
222
222
  });
223
223
  }
224
224
  /**
225
- * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
225
+ * 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.
226
226
  * Update Document Handler
227
227
  */
228
228
  updateDocumentRaw(requestParameters, initOverrides) {
@@ -249,7 +249,7 @@ export class DocumentsApi extends runtime.BaseAPI {
249
249
  });
250
250
  }
251
251
  /**
252
- * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
252
+ * 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.
253
253
  * Update Document Handler
254
254
  */
255
255
  updateDocument(requestParameters, initOverrides) {
@@ -32,7 +32,7 @@ export interface ListFolderContentsRequest {
32
32
  ksUat?: string;
33
33
  }
34
34
  export interface ListFoldersRequest {
35
- parentId?: string;
35
+ parentFolderId?: string;
36
36
  sortOrder?: PathOrder;
37
37
  limit?: number;
38
38
  offset?: number;
@@ -115,9 +115,9 @@ export interface FoldersApiInterface {
115
115
  */
116
116
  listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
117
117
  /**
118
- * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
118
+ * 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.
119
119
  * @summary List Folders Handler
120
- * @param {string} [parentId] Parent folder PathPart ID (defaults to root)
120
+ * @param {string} [parentFolderId] Parent folder ID (defaults to root)
121
121
  * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
122
122
  * @param {number} [limit] Number of items per page
123
123
  * @param {number} [offset] Number of items to skip
@@ -128,12 +128,12 @@ export interface FoldersApiInterface {
128
128
  */
129
129
  listFoldersRaw(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderResponse>>;
130
130
  /**
131
- * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
131
+ * 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.
132
132
  * List Folders Handler
133
133
  */
134
134
  listFolders(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
135
135
  /**
136
- * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
136
+ * 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.
137
137
  * @summary Update Folder Handler
138
138
  * @param {string} folderId
139
139
  * @param {UpdateFolderRequest} updateFolderRequest
@@ -144,7 +144,7 @@ export interface FoldersApiInterface {
144
144
  */
145
145
  updateFolderRaw(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>>;
146
146
  /**
147
- * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
147
+ * 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.
148
148
  * Update Folder Handler
149
149
  */
150
150
  updateFolder(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
@@ -194,22 +194,22 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
194
194
  */
195
195
  listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
196
196
  /**
197
- * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
197
+ * 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.
198
198
  * List Folders Handler
199
199
  */
200
200
  listFoldersRaw(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderResponse>>;
201
201
  /**
202
- * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
202
+ * 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.
203
203
  * List Folders Handler
204
204
  */
205
205
  listFolders(requestParameters?: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
206
206
  /**
207
- * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
207
+ * 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.
208
208
  * Update Folder Handler
209
209
  */
210
210
  updateFolderRaw(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>>;
211
211
  /**
212
- * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
212
+ * 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.
213
213
  * Update Folder Handler
214
214
  */
215
215
  updateFolder(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
@@ -167,14 +167,14 @@ export class FoldersApi extends runtime.BaseAPI {
167
167
  });
168
168
  }
169
169
  /**
170
- * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
170
+ * 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.
171
171
  * List Folders Handler
172
172
  */
173
173
  listFoldersRaw(requestParameters, initOverrides) {
174
174
  return __awaiter(this, void 0, void 0, function* () {
175
175
  const queryParameters = {};
176
- if (requestParameters['parentId'] != null) {
177
- queryParameters['parent_id'] = requestParameters['parentId'];
176
+ if (requestParameters['parentFolderId'] != null) {
177
+ queryParameters['parent_folder_id'] = requestParameters['parentFolderId'];
178
178
  }
179
179
  if (requestParameters['sortOrder'] != null) {
180
180
  queryParameters['sort_order'] = requestParameters['sortOrder'];
@@ -197,7 +197,7 @@ export class FoldersApi extends runtime.BaseAPI {
197
197
  });
198
198
  }
199
199
  /**
200
- * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
200
+ * 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.
201
201
  * List Folders Handler
202
202
  */
203
203
  listFolders() {
@@ -207,7 +207,7 @@ export class FoldersApi extends runtime.BaseAPI {
207
207
  });
208
208
  }
209
209
  /**
210
- * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
210
+ * 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.
211
211
  * Update Folder Handler
212
212
  */
213
213
  updateFolderRaw(requestParameters, initOverrides) {
@@ -234,7 +234,7 @@ export class FoldersApi extends runtime.BaseAPI {
234
234
  });
235
235
  }
236
236
  /**
237
- * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
237
+ * 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.
238
238
  * Update Folder Handler
239
239
  */
240
240
  updateFolder(requestParameters, initOverrides) {
@@ -0,0 +1,117 @@
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 * as runtime from '../runtime';
13
+ import type { PaginatedResponseWorkflowSummaryResponse, WorkflowAction, WorkflowActionResponse, WorkflowDetailResponse } from '../models/index';
14
+ export interface GetWorkflowRequest {
15
+ workflowId: string;
16
+ ksUat?: string;
17
+ }
18
+ export interface ListWorkflowsRequest {
19
+ limit?: number;
20
+ offset?: number;
21
+ ksUat?: string;
22
+ }
23
+ export interface WorkflowActionRequest {
24
+ workflowId: string;
25
+ action: WorkflowAction;
26
+ ksUat?: string;
27
+ }
28
+ /**
29
+ * WorkflowsApi - interface
30
+ *
31
+ * @export
32
+ * @interface WorkflowsApiInterface
33
+ */
34
+ export interface WorkflowsApiInterface {
35
+ /**
36
+ * Get single workflow detail with live Temporal status.
37
+ * @summary Get Workflow Handler
38
+ * @param {string} workflowId
39
+ * @param {string} [ksUat]
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ * @memberof WorkflowsApiInterface
43
+ */
44
+ getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
45
+ /**
46
+ * Get single workflow detail with live Temporal status.
47
+ * Get Workflow Handler
48
+ */
49
+ getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
50
+ /**
51
+ * List all workflows for the current tenant (paginated, DB-backed).
52
+ * @summary List Workflows Handler
53
+ * @param {number} [limit] Number of items per page
54
+ * @param {number} [offset] Number of items to skip
55
+ * @param {string} [ksUat]
56
+ * @param {*} [options] Override http request option.
57
+ * @throws {RequiredError}
58
+ * @memberof WorkflowsApiInterface
59
+ */
60
+ listWorkflowsRaw(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
61
+ /**
62
+ * List all workflows for the current tenant (paginated, DB-backed).
63
+ * List Workflows Handler
64
+ */
65
+ listWorkflows(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
66
+ /**
67
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
68
+ * @summary Workflow Action Handler
69
+ * @param {string} workflowId
70
+ * @param {WorkflowAction} action Action to perform
71
+ * @param {string} [ksUat]
72
+ * @param {*} [options] Override http request option.
73
+ * @throws {RequiredError}
74
+ * @memberof WorkflowsApiInterface
75
+ */
76
+ workflowActionRaw(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
77
+ /**
78
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
79
+ * Workflow Action Handler
80
+ */
81
+ workflowAction(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
82
+ }
83
+ /**
84
+ *
85
+ */
86
+ export declare class WorkflowsApi extends runtime.BaseAPI implements WorkflowsApiInterface {
87
+ /**
88
+ * Get single workflow detail with live Temporal status.
89
+ * Get Workflow Handler
90
+ */
91
+ getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
92
+ /**
93
+ * Get single workflow detail with live Temporal status.
94
+ * Get Workflow Handler
95
+ */
96
+ getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
97
+ /**
98
+ * List all workflows for the current tenant (paginated, DB-backed).
99
+ * List Workflows Handler
100
+ */
101
+ listWorkflowsRaw(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
102
+ /**
103
+ * List all workflows for the current tenant (paginated, DB-backed).
104
+ * List Workflows Handler
105
+ */
106
+ listWorkflows(requestParameters?: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
107
+ /**
108
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
109
+ * Workflow Action Handler
110
+ */
111
+ workflowActionRaw(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
112
+ /**
113
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
114
+ * Workflow Action Handler
115
+ */
116
+ workflowAction(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
117
+ }
@@ -0,0 +1,133 @@
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
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ import * as runtime from '../runtime';
24
+ import { PaginatedResponseWorkflowSummaryResponseFromJSON, WorkflowActionResponseFromJSON, WorkflowDetailResponseFromJSON, } from '../models/index';
25
+ /**
26
+ *
27
+ */
28
+ export class WorkflowsApi extends runtime.BaseAPI {
29
+ /**
30
+ * Get single workflow detail with live Temporal status.
31
+ * Get Workflow Handler
32
+ */
33
+ getWorkflowRaw(requestParameters, initOverrides) {
34
+ return __awaiter(this, void 0, void 0, function* () {
35
+ if (requestParameters['workflowId'] == null) {
36
+ throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling getWorkflow().');
37
+ }
38
+ const queryParameters = {};
39
+ const headerParameters = {};
40
+ let urlPath = `/v1/workflows/{workflow_id}`;
41
+ urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
42
+ const response = yield this.request({
43
+ path: urlPath,
44
+ method: 'GET',
45
+ headers: headerParameters,
46
+ query: queryParameters,
47
+ }, initOverrides);
48
+ return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowDetailResponseFromJSON(jsonValue));
49
+ });
50
+ }
51
+ /**
52
+ * Get single workflow detail with live Temporal status.
53
+ * Get Workflow Handler
54
+ */
55
+ getWorkflow(requestParameters, initOverrides) {
56
+ return __awaiter(this, void 0, void 0, function* () {
57
+ const response = yield this.getWorkflowRaw(requestParameters, initOverrides);
58
+ return yield response.value();
59
+ });
60
+ }
61
+ /**
62
+ * List all workflows for the current tenant (paginated, DB-backed).
63
+ * List Workflows Handler
64
+ */
65
+ listWorkflowsRaw(requestParameters, initOverrides) {
66
+ return __awaiter(this, void 0, void 0, function* () {
67
+ const queryParameters = {};
68
+ if (requestParameters['limit'] != null) {
69
+ queryParameters['limit'] = requestParameters['limit'];
70
+ }
71
+ if (requestParameters['offset'] != null) {
72
+ queryParameters['offset'] = requestParameters['offset'];
73
+ }
74
+ const headerParameters = {};
75
+ let urlPath = `/v1/workflows`;
76
+ const response = yield this.request({
77
+ path: urlPath,
78
+ method: 'GET',
79
+ headers: headerParameters,
80
+ query: queryParameters,
81
+ }, initOverrides);
82
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseWorkflowSummaryResponseFromJSON(jsonValue));
83
+ });
84
+ }
85
+ /**
86
+ * List all workflows for the current tenant (paginated, DB-backed).
87
+ * List Workflows Handler
88
+ */
89
+ listWorkflows() {
90
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
91
+ const response = yield this.listWorkflowsRaw(requestParameters, initOverrides);
92
+ return yield response.value();
93
+ });
94
+ }
95
+ /**
96
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
97
+ * Workflow Action Handler
98
+ */
99
+ workflowActionRaw(requestParameters, initOverrides) {
100
+ return __awaiter(this, void 0, void 0, function* () {
101
+ if (requestParameters['workflowId'] == null) {
102
+ throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling workflowAction().');
103
+ }
104
+ if (requestParameters['action'] == null) {
105
+ throw new runtime.RequiredError('action', 'Required parameter "action" was null or undefined when calling workflowAction().');
106
+ }
107
+ const queryParameters = {};
108
+ if (requestParameters['action'] != null) {
109
+ queryParameters['action'] = requestParameters['action'];
110
+ }
111
+ const headerParameters = {};
112
+ let urlPath = `/v1/workflows/{workflow_id}`;
113
+ urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
114
+ const response = yield this.request({
115
+ path: urlPath,
116
+ method: 'POST',
117
+ headers: headerParameters,
118
+ query: queryParameters,
119
+ }, initOverrides);
120
+ return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowActionResponseFromJSON(jsonValue));
121
+ });
122
+ }
123
+ /**
124
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
125
+ * Workflow Action Handler
126
+ */
127
+ workflowAction(requestParameters, initOverrides) {
128
+ return __awaiter(this, void 0, void 0, function* () {
129
+ const response = yield this.workflowActionRaw(requestParameters, initOverrides);
130
+ return yield response.value();
131
+ });
132
+ }
133
+ }
@@ -14,3 +14,4 @@ export * from './ThreadMessagesApi';
14
14
  export * from './ThreadsApi';
15
15
  export * from './UserPermissionsApi';
16
16
  export * from './UsersApi';
17
+ export * from './WorkflowsApi';
@@ -16,3 +16,4 @@ export * from './ThreadMessagesApi';
16
16
  export * from './ThreadsApi';
17
17
  export * from './UserPermissionsApi';
18
18
  export * from './UsersApi';
19
+ export * from './WorkflowsApi';
@@ -24,11 +24,11 @@ export interface CreateDocumentRequest {
24
24
  */
25
25
  name: string;
26
26
  /**
27
- * Parent folder PathPart ID
27
+ * Parent folder ID
28
28
  * @type {string}
29
29
  * @memberof CreateDocumentRequest
30
30
  */
31
- parentId: string;
31
+ parentFolderId: string;
32
32
  /**
33
33
  * Type of document (PDF, UNKNOWN, etc.)
34
34
  * @type {DocumentType}
@@ -19,7 +19,7 @@ import { DocumentTypeFromJSON, DocumentTypeToJSON, } from './DocumentType';
19
19
  export function instanceOfCreateDocumentRequest(value) {
20
20
  if (!('name' in value) || value['name'] === undefined)
21
21
  return false;
22
- if (!('parentId' in value) || value['parentId'] === undefined)
22
+ if (!('parentFolderId' in value) || value['parentFolderId'] === undefined)
23
23
  return false;
24
24
  if (!('documentType' in value) || value['documentType'] === undefined)
25
25
  return false;
@@ -36,7 +36,7 @@ export function CreateDocumentRequestFromJSONTyped(json, ignoreDiscriminator) {
36
36
  }
37
37
  return {
38
38
  'name': json['name'],
39
- 'parentId': json['parent_id'],
39
+ 'parentFolderId': json['parent_folder_id'],
40
40
  'documentType': DocumentTypeFromJSON(json['document_type']),
41
41
  'documentOrigin': DocumentOriginFromJSON(json['document_origin']),
42
42
  };
@@ -50,7 +50,7 @@ export function CreateDocumentRequestToJSONTyped(value, ignoreDiscriminator = fa
50
50
  }
51
51
  return {
52
52
  'name': value['name'],
53
- 'parent_id': value['parentId'],
53
+ 'parent_folder_id': value['parentFolderId'],
54
54
  'document_type': DocumentTypeToJSON(value['documentType']),
55
55
  'document_origin': DocumentOriginToJSON(value['documentOrigin']),
56
56
  };