@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
@@ -19,10 +19,9 @@ src/apis/ThreadMessagesApi.ts
19
19
  src/apis/ThreadsApi.ts
20
20
  src/apis/UserPermissionsApi.ts
21
21
  src/apis/UsersApi.ts
22
+ src/apis/WorkflowsApi.ts
22
23
  src/apis/index.ts
23
24
  src/index.ts
24
- src/models/AssumeUserRequest.ts
25
- src/models/AssumeUserResponse.ts
26
25
  src/models/ChunkLineageResponse.ts
27
26
  src/models/ChunkMetadataInput.ts
28
27
  src/models/ChunkMetadataOutput.ts
@@ -77,6 +76,7 @@ src/models/PaginatedResponseTenantResponse.ts
77
76
  src/models/PaginatedResponseTenantUserInTenantResponse.ts
78
77
  src/models/PaginatedResponseThreadMessageResponse.ts
79
78
  src/models/PaginatedResponseThreadResponse.ts
79
+ src/models/PaginatedResponseWorkflowSummaryResponse.ts
80
80
  src/models/PartType.ts
81
81
  src/models/PasswordResetRequest.ts
82
82
  src/models/PasswordResetWithTokenRequest.ts
@@ -112,6 +112,10 @@ src/models/UpdateUserRequest.ts
112
112
  src/models/UserResponse.ts
113
113
  src/models/ValidationError.ts
114
114
  src/models/ValidationErrorLocInner.ts
115
+ src/models/WorkflowAction.ts
116
+ src/models/WorkflowActionResponse.ts
117
+ src/models/WorkflowDetailResponse.ts
118
+ src/models/WorkflowSummaryResponse.ts
115
119
  src/models/index.ts
116
120
  src/runtime.ts
117
121
  tsconfig.esm.json
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @knowledge-stack/ksapi@1.16.0
1
+ ## @knowledge-stack/ksapi@1.17.1
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @knowledge-stack/ksapi@1.16.0 --save
39
+ npm install @knowledge-stack/ksapi@1.17.1 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -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
  */
@@ -29,45 +29,6 @@ const index_1 = require("../models/index");
29
29
  *
30
30
  */
31
31
  class AuthApi extends runtime.BaseAPI {
32
- /**
33
- * 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.
34
- * Assume User Identity Handler
35
- */
36
- assumeUserRaw(requestParameters, initOverrides) {
37
- return __awaiter(this, void 0, void 0, function* () {
38
- if (requestParameters['xAdminApiKey'] == null) {
39
- throw new runtime.RequiredError('xAdminApiKey', 'Required parameter "xAdminApiKey" was null or undefined when calling assumeUser().');
40
- }
41
- if (requestParameters['assumeUserRequest'] == null) {
42
- throw new runtime.RequiredError('assumeUserRequest', 'Required parameter "assumeUserRequest" was null or undefined when calling assumeUser().');
43
- }
44
- const queryParameters = {};
45
- const headerParameters = {};
46
- headerParameters['Content-Type'] = 'application/json';
47
- if (requestParameters['xAdminApiKey'] != null) {
48
- headerParameters['x-admin-api-key'] = String(requestParameters['xAdminApiKey']);
49
- }
50
- let urlPath = `/v1/auth/assume_user`;
51
- const response = yield this.request({
52
- path: urlPath,
53
- method: 'POST',
54
- headers: headerParameters,
55
- query: queryParameters,
56
- body: (0, index_1.AssumeUserRequestToJSON)(requestParameters['assumeUserRequest']),
57
- }, initOverrides);
58
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AssumeUserResponseFromJSON)(jsonValue));
59
- });
60
- }
61
- /**
62
- * 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.
63
- * Assume User Identity Handler
64
- */
65
- assumeUser(requestParameters, initOverrides) {
66
- return __awaiter(this, void 0, void 0, function* () {
67
- const response = yield this.assumeUserRaw(requestParameters, initOverrides);
68
- return yield response.value();
69
- });
70
- }
71
32
  /**
72
33
  * Create Password User Handler
73
34
  */
@@ -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>;
@@ -185,14 +185,14 @@ class DocumentsApi extends runtime.BaseAPI {
185
185
  });
186
186
  }
187
187
  /**
188
- * 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.
188
+ * 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.
189
189
  * List Documents Handler
190
190
  */
191
191
  listDocumentsRaw(requestParameters, initOverrides) {
192
192
  return __awaiter(this, void 0, void 0, function* () {
193
193
  const queryParameters = {};
194
- if (requestParameters['parentId'] != null) {
195
- queryParameters['parent_id'] = requestParameters['parentId'];
194
+ if (requestParameters['parentFolderId'] != null) {
195
+ queryParameters['parent_folder_id'] = requestParameters['parentFolderId'];
196
196
  }
197
197
  if (requestParameters['sortOrder'] != null) {
198
198
  queryParameters['sort_order'] = requestParameters['sortOrder'];
@@ -215,7 +215,7 @@ class DocumentsApi extends runtime.BaseAPI {
215
215
  });
216
216
  }
217
217
  /**
218
- * 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.
218
+ * 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.
219
219
  * List Documents Handler
220
220
  */
221
221
  listDocuments() {
@@ -225,7 +225,7 @@ class DocumentsApi extends runtime.BaseAPI {
225
225
  });
226
226
  }
227
227
  /**
228
- * 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.
228
+ * 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.
229
229
  * Update Document Handler
230
230
  */
231
231
  updateDocumentRaw(requestParameters, initOverrides) {
@@ -252,7 +252,7 @@ class DocumentsApi extends runtime.BaseAPI {
252
252
  });
253
253
  }
254
254
  /**
255
- * 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.
255
+ * 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.
256
256
  * Update Document Handler
257
257
  */
258
258
  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>;
@@ -170,14 +170,14 @@ class FoldersApi extends runtime.BaseAPI {
170
170
  });
171
171
  }
172
172
  /**
173
- * 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.
173
+ * 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.
174
174
  * List Folders Handler
175
175
  */
176
176
  listFoldersRaw(requestParameters, initOverrides) {
177
177
  return __awaiter(this, void 0, void 0, function* () {
178
178
  const queryParameters = {};
179
- if (requestParameters['parentId'] != null) {
180
- queryParameters['parent_id'] = requestParameters['parentId'];
179
+ if (requestParameters['parentFolderId'] != null) {
180
+ queryParameters['parent_folder_id'] = requestParameters['parentFolderId'];
181
181
  }
182
182
  if (requestParameters['sortOrder'] != null) {
183
183
  queryParameters['sort_order'] = requestParameters['sortOrder'];
@@ -200,7 +200,7 @@ class FoldersApi extends runtime.BaseAPI {
200
200
  });
201
201
  }
202
202
  /**
203
- * 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.
203
+ * 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.
204
204
  * List Folders Handler
205
205
  */
206
206
  listFolders() {
@@ -210,7 +210,7 @@ class FoldersApi extends runtime.BaseAPI {
210
210
  });
211
211
  }
212
212
  /**
213
- * 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.
213
+ * 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.
214
214
  * Update Folder Handler
215
215
  */
216
216
  updateFolderRaw(requestParameters, initOverrides) {
@@ -237,7 +237,7 @@ class FoldersApi extends runtime.BaseAPI {
237
237
  });
238
238
  }
239
239
  /**
240
- * 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.
240
+ * 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.
241
241
  * Update Folder Handler
242
242
  */
243
243
  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,137 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Knowledge Stack API
6
+ * Knowledge Stack backend API for authentication and knowledge management
7
+ *
8
+ * The version of the OpenAPI document: 0.1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
16
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
17
+ return new (P || (P = Promise))(function (resolve, reject) {
18
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
19
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
20
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
21
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
22
+ });
23
+ };
24
+ Object.defineProperty(exports, "__esModule", { value: true });
25
+ exports.WorkflowsApi = void 0;
26
+ const runtime = require("../runtime");
27
+ const index_1 = require("../models/index");
28
+ /**
29
+ *
30
+ */
31
+ class WorkflowsApi extends runtime.BaseAPI {
32
+ /**
33
+ * Get single workflow detail with live Temporal status.
34
+ * Get Workflow Handler
35
+ */
36
+ getWorkflowRaw(requestParameters, initOverrides) {
37
+ return __awaiter(this, void 0, void 0, function* () {
38
+ if (requestParameters['workflowId'] == null) {
39
+ throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling getWorkflow().');
40
+ }
41
+ const queryParameters = {};
42
+ const headerParameters = {};
43
+ let urlPath = `/v1/workflows/{workflow_id}`;
44
+ urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
45
+ const response = yield this.request({
46
+ path: urlPath,
47
+ method: 'GET',
48
+ headers: headerParameters,
49
+ query: queryParameters,
50
+ }, initOverrides);
51
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowDetailResponseFromJSON)(jsonValue));
52
+ });
53
+ }
54
+ /**
55
+ * Get single workflow detail with live Temporal status.
56
+ * Get Workflow Handler
57
+ */
58
+ getWorkflow(requestParameters, initOverrides) {
59
+ return __awaiter(this, void 0, void 0, function* () {
60
+ const response = yield this.getWorkflowRaw(requestParameters, initOverrides);
61
+ return yield response.value();
62
+ });
63
+ }
64
+ /**
65
+ * List all workflows for the current tenant (paginated, DB-backed).
66
+ * List Workflows Handler
67
+ */
68
+ listWorkflowsRaw(requestParameters, initOverrides) {
69
+ return __awaiter(this, void 0, void 0, function* () {
70
+ const queryParameters = {};
71
+ if (requestParameters['limit'] != null) {
72
+ queryParameters['limit'] = requestParameters['limit'];
73
+ }
74
+ if (requestParameters['offset'] != null) {
75
+ queryParameters['offset'] = requestParameters['offset'];
76
+ }
77
+ const headerParameters = {};
78
+ let urlPath = `/v1/workflows`;
79
+ const response = yield this.request({
80
+ path: urlPath,
81
+ method: 'GET',
82
+ headers: headerParameters,
83
+ query: queryParameters,
84
+ }, initOverrides);
85
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseWorkflowSummaryResponseFromJSON)(jsonValue));
86
+ });
87
+ }
88
+ /**
89
+ * List all workflows for the current tenant (paginated, DB-backed).
90
+ * List Workflows Handler
91
+ */
92
+ listWorkflows() {
93
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
94
+ const response = yield this.listWorkflowsRaw(requestParameters, initOverrides);
95
+ return yield response.value();
96
+ });
97
+ }
98
+ /**
99
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
100
+ * Workflow Action Handler
101
+ */
102
+ workflowActionRaw(requestParameters, initOverrides) {
103
+ return __awaiter(this, void 0, void 0, function* () {
104
+ if (requestParameters['workflowId'] == null) {
105
+ throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling workflowAction().');
106
+ }
107
+ if (requestParameters['action'] == null) {
108
+ throw new runtime.RequiredError('action', 'Required parameter "action" was null or undefined when calling workflowAction().');
109
+ }
110
+ const queryParameters = {};
111
+ if (requestParameters['action'] != null) {
112
+ queryParameters['action'] = requestParameters['action'];
113
+ }
114
+ const headerParameters = {};
115
+ let urlPath = `/v1/workflows/{workflow_id}`;
116
+ urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
117
+ const response = yield this.request({
118
+ path: urlPath,
119
+ method: 'POST',
120
+ headers: headerParameters,
121
+ query: queryParameters,
122
+ }, initOverrides);
123
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowActionResponseFromJSON)(jsonValue));
124
+ });
125
+ }
126
+ /**
127
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
128
+ * Workflow Action Handler
129
+ */
130
+ workflowAction(requestParameters, initOverrides) {
131
+ return __awaiter(this, void 0, void 0, function* () {
132
+ const response = yield this.workflowActionRaw(requestParameters, initOverrides);
133
+ return yield response.value();
134
+ });
135
+ }
136
+ }
137
+ exports.WorkflowsApi = WorkflowsApi;
@@ -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';
@@ -32,3 +32,4 @@ __exportStar(require("./ThreadMessagesApi"), exports);
32
32
  __exportStar(require("./ThreadsApi"), exports);
33
33
  __exportStar(require("./UserPermissionsApi"), exports);
34
34
  __exportStar(require("./UsersApi"), exports);
35
+ __exportStar(require("./WorkflowsApi"), exports);