@knowledge-stack/ksapi 1.15.0 → 1.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/.openapi-generator/FILES +11 -0
  2. package/README.md +2 -2
  3. package/dist/apis/DocumentVersionsApi.d.ts +32 -1
  4. package/dist/apis/DocumentVersionsApi.js +37 -0
  5. package/dist/apis/DocumentsApi.d.ts +44 -11
  6. package/dist/apis/DocumentsApi.js +65 -6
  7. package/dist/apis/FoldersApi.d.ts +10 -10
  8. package/dist/apis/FoldersApi.js +6 -6
  9. package/dist/apis/TenantsApi.d.ts +4 -4
  10. package/dist/apis/TenantsApi.js +2 -2
  11. package/dist/apis/WorkflowsApi.d.ts +117 -0
  12. package/dist/apis/WorkflowsApi.js +137 -0
  13. package/dist/apis/index.d.ts +1 -0
  14. package/dist/apis/index.js +1 -0
  15. package/dist/esm/apis/DocumentVersionsApi.d.ts +32 -1
  16. package/dist/esm/apis/DocumentVersionsApi.js +38 -1
  17. package/dist/esm/apis/DocumentsApi.d.ts +44 -11
  18. package/dist/esm/apis/DocumentsApi.js +66 -7
  19. package/dist/esm/apis/FoldersApi.d.ts +10 -10
  20. package/dist/esm/apis/FoldersApi.js +6 -6
  21. package/dist/esm/apis/TenantsApi.d.ts +4 -4
  22. package/dist/esm/apis/TenantsApi.js +2 -2
  23. package/dist/esm/apis/WorkflowsApi.d.ts +117 -0
  24. package/dist/esm/apis/WorkflowsApi.js +133 -0
  25. package/dist/esm/apis/index.d.ts +1 -0
  26. package/dist/esm/apis/index.js +1 -0
  27. package/dist/esm/models/CreateDocumentRequest.d.ts +2 -2
  28. package/dist/esm/models/CreateDocumentRequest.js +3 -3
  29. package/dist/esm/models/CreateFolderRequest.d.ts +2 -2
  30. package/dist/esm/models/CreateFolderRequest.js +3 -3
  31. package/dist/esm/models/DocumentResponse.d.ts +2 -2
  32. package/dist/esm/models/DocumentResponse.js +3 -3
  33. package/dist/esm/models/DocumentVersionMetadata.d.ts +89 -0
  34. package/dist/esm/models/DocumentVersionMetadata.js +55 -0
  35. package/dist/esm/models/DocumentVersionMetadataUpdate.d.ts +87 -0
  36. package/dist/esm/models/DocumentVersionMetadataUpdate.js +55 -0
  37. package/dist/esm/models/DocumentVersionResponse.d.ts +13 -0
  38. package/dist/esm/models/DocumentVersionResponse.js +5 -0
  39. package/dist/esm/models/FolderResponse.d.ts +2 -2
  40. package/dist/esm/models/FolderResponse.js +3 -3
  41. package/dist/esm/models/IngestDocumentResponse.d.ts +59 -0
  42. package/dist/esm/models/IngestDocumentResponse.js +52 -0
  43. package/dist/esm/models/PaginatedResponseWorkflowSummaryResponse.d.ts +66 -0
  44. package/dist/esm/models/PaginatedResponseWorkflowSummaryResponse.js +70 -0
  45. package/dist/esm/models/PipelineState.d.ts +78 -0
  46. package/dist/esm/models/PipelineState.js +57 -0
  47. package/dist/esm/models/PipelineStatus.d.ts +28 -0
  48. package/dist/esm/models/PipelineStatus.js +46 -0
  49. package/dist/esm/models/UpdateDocumentRequest.d.ts +2 -2
  50. package/dist/esm/models/UpdateDocumentRequest.js +2 -2
  51. package/dist/esm/models/UpdateFolderRequest.d.ts +2 -2
  52. package/dist/esm/models/UpdateFolderRequest.js +2 -2
  53. package/dist/esm/models/WorkflowAction.d.ts +25 -0
  54. package/dist/esm/models/WorkflowAction.js +43 -0
  55. package/dist/esm/models/WorkflowActionResponse.d.ts +59 -0
  56. package/dist/esm/models/WorkflowActionResponse.js +52 -0
  57. package/dist/esm/models/WorkflowDetailResponse.d.ts +132 -0
  58. package/dist/esm/models/WorkflowDetailResponse.js +93 -0
  59. package/dist/esm/models/WorkflowSummaryResponse.d.ts +90 -0
  60. package/dist/esm/models/WorkflowSummaryResponse.js +69 -0
  61. package/dist/esm/models/index.d.ts +10 -0
  62. package/dist/esm/models/index.js +10 -0
  63. package/dist/models/CreateDocumentRequest.d.ts +2 -2
  64. package/dist/models/CreateDocumentRequest.js +3 -3
  65. package/dist/models/CreateFolderRequest.d.ts +2 -2
  66. package/dist/models/CreateFolderRequest.js +3 -3
  67. package/dist/models/DocumentResponse.d.ts +2 -2
  68. package/dist/models/DocumentResponse.js +3 -3
  69. package/dist/models/DocumentVersionMetadata.d.ts +89 -0
  70. package/dist/models/DocumentVersionMetadata.js +63 -0
  71. package/dist/models/DocumentVersionMetadataUpdate.d.ts +87 -0
  72. package/dist/models/DocumentVersionMetadataUpdate.js +63 -0
  73. package/dist/models/DocumentVersionResponse.d.ts +13 -0
  74. package/dist/models/DocumentVersionResponse.js +5 -0
  75. package/dist/models/FolderResponse.d.ts +2 -2
  76. package/dist/models/FolderResponse.js +3 -3
  77. package/dist/models/IngestDocumentResponse.d.ts +59 -0
  78. package/dist/models/IngestDocumentResponse.js +60 -0
  79. package/dist/models/PaginatedResponseWorkflowSummaryResponse.d.ts +66 -0
  80. package/dist/models/PaginatedResponseWorkflowSummaryResponse.js +78 -0
  81. package/dist/models/PipelineState.d.ts +78 -0
  82. package/dist/models/PipelineState.js +65 -0
  83. package/dist/models/PipelineStatus.d.ts +28 -0
  84. package/dist/models/PipelineStatus.js +54 -0
  85. package/dist/models/UpdateDocumentRequest.d.ts +2 -2
  86. package/dist/models/UpdateDocumentRequest.js +2 -2
  87. package/dist/models/UpdateFolderRequest.d.ts +2 -2
  88. package/dist/models/UpdateFolderRequest.js +2 -2
  89. package/dist/models/WorkflowAction.d.ts +25 -0
  90. package/dist/models/WorkflowAction.js +51 -0
  91. package/dist/models/WorkflowActionResponse.d.ts +59 -0
  92. package/dist/models/WorkflowActionResponse.js +60 -0
  93. package/dist/models/WorkflowDetailResponse.d.ts +132 -0
  94. package/dist/models/WorkflowDetailResponse.js +101 -0
  95. package/dist/models/WorkflowSummaryResponse.d.ts +90 -0
  96. package/dist/models/WorkflowSummaryResponse.js +77 -0
  97. package/dist/models/index.d.ts +10 -0
  98. package/dist/models/index.js +10 -0
  99. package/package.json +1 -1
  100. package/src/apis/DocumentVersionsApi.ts +76 -0
  101. package/src/apis/DocumentsApi.ts +115 -12
  102. package/src/apis/FoldersApi.ts +12 -12
  103. package/src/apis/TenantsApi.ts +4 -4
  104. package/src/apis/WorkflowsApi.ts +249 -0
  105. package/src/apis/index.ts +1 -0
  106. package/src/models/CreateDocumentRequest.ts +5 -5
  107. package/src/models/CreateFolderRequest.ts +5 -5
  108. package/src/models/DocumentResponse.ts +5 -5
  109. package/src/models/DocumentVersionMetadata.ts +143 -0
  110. package/src/models/DocumentVersionMetadataUpdate.ts +141 -0
  111. package/src/models/DocumentVersionResponse.ts +24 -0
  112. package/src/models/FolderResponse.ts +5 -5
  113. package/src/models/IngestDocumentResponse.ts +101 -0
  114. package/src/models/PaginatedResponseWorkflowSummaryResponse.ts +130 -0
  115. package/src/models/PipelineState.ts +134 -0
  116. package/src/models/PipelineStatus.ts +56 -0
  117. package/src/models/UpdateDocumentRequest.ts +4 -4
  118. package/src/models/UpdateFolderRequest.ts +4 -4
  119. package/src/models/WorkflowAction.ts +53 -0
  120. package/src/models/WorkflowActionResponse.ts +101 -0
  121. package/src/models/WorkflowDetailResponse.ts +215 -0
  122. package/src/models/WorkflowSummaryResponse.ts +154 -0
  123. package/src/models/index.ts +10 -0
@@ -15,12 +15,15 @@
15
15
 
16
16
  import * as runtime from '../runtime';
17
17
  import type {
18
+ DocumentVersionMetadataUpdate,
18
19
  DocumentVersionResponse,
19
20
  HTTPValidationError,
20
21
  PaginatedResponseDocumentContentPathPart,
21
22
  PaginatedResponseDocumentVersionResponse,
22
23
  } from '../models/index';
23
24
  import {
25
+ DocumentVersionMetadataUpdateFromJSON,
26
+ DocumentVersionMetadataUpdateToJSON,
24
27
  DocumentVersionResponseFromJSON,
25
28
  DocumentVersionResponseToJSON,
26
29
  HTTPValidationErrorFromJSON,
@@ -61,6 +64,12 @@ export interface ListDocumentVersionsRequest {
61
64
  ksUat?: string;
62
65
  }
63
66
 
67
+ export interface UpdateDocumentVersionMetadataRequest {
68
+ versionId: string;
69
+ documentVersionMetadataUpdate: DocumentVersionMetadataUpdate;
70
+ ksUat?: string;
71
+ }
72
+
64
73
  /**
65
74
  * DocumentVersionsApi - interface
66
75
  *
@@ -158,6 +167,24 @@ export interface DocumentVersionsApiInterface {
158
167
  */
159
168
  listDocumentVersions(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentVersionResponse>;
160
169
 
170
+ /**
171
+ * Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
172
+ * @summary Update Document Version Metadata Handler
173
+ * @param {string} versionId DocumentVersion ID
174
+ * @param {DocumentVersionMetadataUpdate} documentVersionMetadataUpdate
175
+ * @param {string} [ksUat]
176
+ * @param {*} [options] Override http request option.
177
+ * @throws {RequiredError}
178
+ * @memberof DocumentVersionsApiInterface
179
+ */
180
+ updateDocumentVersionMetadataRaw(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
181
+
182
+ /**
183
+ * Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
184
+ * Update Document Version Metadata Handler
185
+ */
186
+ updateDocumentVersionMetadata(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
187
+
161
188
  }
162
189
 
163
190
  /**
@@ -382,4 +409,53 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
382
409
  return await response.value();
383
410
  }
384
411
 
412
+ /**
413
+ * Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
414
+ * Update Document Version Metadata Handler
415
+ */
416
+ async updateDocumentVersionMetadataRaw(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>> {
417
+ if (requestParameters['versionId'] == null) {
418
+ throw new runtime.RequiredError(
419
+ 'versionId',
420
+ 'Required parameter "versionId" was null or undefined when calling updateDocumentVersionMetadata().'
421
+ );
422
+ }
423
+
424
+ if (requestParameters['documentVersionMetadataUpdate'] == null) {
425
+ throw new runtime.RequiredError(
426
+ 'documentVersionMetadataUpdate',
427
+ 'Required parameter "documentVersionMetadataUpdate" was null or undefined when calling updateDocumentVersionMetadata().'
428
+ );
429
+ }
430
+
431
+ const queryParameters: any = {};
432
+
433
+ const headerParameters: runtime.HTTPHeaders = {};
434
+
435
+ headerParameters['Content-Type'] = 'application/json';
436
+
437
+
438
+ let urlPath = `/v1/document_versions/{version_id}/metadata`;
439
+ urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
440
+
441
+ const response = await this.request({
442
+ path: urlPath,
443
+ method: 'PATCH',
444
+ headers: headerParameters,
445
+ query: queryParameters,
446
+ body: DocumentVersionMetadataUpdateToJSON(requestParameters['documentVersionMetadataUpdate']),
447
+ }, initOverrides);
448
+
449
+ return new runtime.JSONApiResponse(response, (jsonValue) => DocumentVersionResponseFromJSON(jsonValue));
450
+ }
451
+
452
+ /**
453
+ * Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
454
+ * Update Document Version Metadata Handler
455
+ */
456
+ async updateDocumentVersionMetadata(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse> {
457
+ const response = await this.updateDocumentVersionMetadataRaw(requestParameters, initOverrides);
458
+ return await response.value();
459
+ }
460
+
385
461
  }
@@ -18,6 +18,7 @@ import type {
18
18
  CreateDocumentRequest,
19
19
  DocumentResponse,
20
20
  HTTPValidationError,
21
+ IngestDocumentResponse,
21
22
  PaginatedResponseDocumentResponse,
22
23
  PathOrder,
23
24
  UpdateDocumentRequest,
@@ -29,6 +30,8 @@ import {
29
30
  DocumentResponseToJSON,
30
31
  HTTPValidationErrorFromJSON,
31
32
  HTTPValidationErrorToJSON,
33
+ IngestDocumentResponseFromJSON,
34
+ IngestDocumentResponseToJSON,
32
35
  PaginatedResponseDocumentResponseFromJSON,
33
36
  PaginatedResponseDocumentResponseToJSON,
34
37
  PathOrderFromJSON,
@@ -52,8 +55,15 @@ export interface GetDocumentRequest {
52
55
  ksUat?: string;
53
56
  }
54
57
 
58
+ export interface IngestDocumentRequest {
59
+ file: Blob;
60
+ folderId: string;
61
+ ksUat?: string;
62
+ name?: string;
63
+ }
64
+
55
65
  export interface ListDocumentsRequest {
56
- parentId?: string;
66
+ parentFolderId?: string;
57
67
  sortOrder?: PathOrder;
58
68
  limit?: number;
59
69
  offset?: number;
@@ -125,9 +135,28 @@ export interface DocumentsApiInterface {
125
135
  getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
126
136
 
127
137
  /**
128
- * 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.
138
+ * Upload a file, create document + version, and trigger ingestion workflow. Returns 201 with the Temporal workflow ID. Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
139
+ * @summary Ingest Document Handler
140
+ * @param {Blob} file
141
+ * @param {string} folderId Parent folder ID
142
+ * @param {string} [ksUat]
143
+ * @param {string} [name] Document name (defaults to filename)
144
+ * @param {*} [options] Override http request option.
145
+ * @throws {RequiredError}
146
+ * @memberof DocumentsApiInterface
147
+ */
148
+ ingestDocumentRaw(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>>;
149
+
150
+ /**
151
+ * Upload a file, create document + version, and trigger ingestion workflow. Returns 201 with the Temporal workflow ID. Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
152
+ * Ingest Document Handler
153
+ */
154
+ ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
155
+
156
+ /**
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.
129
158
  * @summary List Documents Handler
130
- * @param {string} [parentId] Parent folder PathPart ID (defaults to root)
159
+ * @param {string} [parentFolderId] Parent folder ID (defaults to root)
131
160
  * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
132
161
  * @param {number} [limit] Number of items per page
133
162
  * @param {number} [offset] Number of items to skip
@@ -139,13 +168,13 @@ export interface DocumentsApiInterface {
139
168
  listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>>;
140
169
 
141
170
  /**
142
- * 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.
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.
143
172
  * List Documents Handler
144
173
  */
145
174
  listDocuments(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse>;
146
175
 
147
176
  /**
148
- * 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.
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.
149
178
  * @summary Update Document Handler
150
179
  * @param {string} documentId
151
180
  * @param {UpdateDocumentRequest} updateDocumentRequest
@@ -157,7 +186,7 @@ export interface DocumentsApiInterface {
157
186
  updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
158
187
 
159
188
  /**
160
- * 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.
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.
161
190
  * Update Document Handler
162
191
  */
163
192
  updateDocument(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
@@ -288,14 +317,88 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
288
317
  }
289
318
 
290
319
  /**
291
- * 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.
320
+ * Upload a file, create document + version, and trigger ingestion workflow. Returns 201 with the Temporal workflow ID. Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
321
+ * Ingest Document Handler
322
+ */
323
+ async ingestDocumentRaw(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>> {
324
+ if (requestParameters['file'] == null) {
325
+ throw new runtime.RequiredError(
326
+ 'file',
327
+ 'Required parameter "file" was null or undefined when calling ingestDocument().'
328
+ );
329
+ }
330
+
331
+ if (requestParameters['folderId'] == null) {
332
+ throw new runtime.RequiredError(
333
+ 'folderId',
334
+ 'Required parameter "folderId" was null or undefined when calling ingestDocument().'
335
+ );
336
+ }
337
+
338
+ const queryParameters: any = {};
339
+
340
+ const headerParameters: runtime.HTTPHeaders = {};
341
+
342
+ const consumes: runtime.Consume[] = [
343
+ { contentType: 'multipart/form-data' },
344
+ ];
345
+ // @ts-ignore: canConsumeForm may be unused
346
+ const canConsumeForm = runtime.canConsumeForm(consumes);
347
+
348
+ let formParams: { append(param: string, value: any): any };
349
+ let useForm = false;
350
+ // use FormData to transmit files using content-type "multipart/form-data"
351
+ useForm = canConsumeForm;
352
+ if (useForm) {
353
+ formParams = new FormData();
354
+ } else {
355
+ formParams = new URLSearchParams();
356
+ }
357
+
358
+ if (requestParameters['file'] != null) {
359
+ formParams.append('file', requestParameters['file'] as any);
360
+ }
361
+
362
+ if (requestParameters['folderId'] != null) {
363
+ formParams.append('folder_id', requestParameters['folderId'] as any);
364
+ }
365
+
366
+ if (requestParameters['name'] != null) {
367
+ formParams.append('name', requestParameters['name'] as any);
368
+ }
369
+
370
+
371
+ let urlPath = `/v1/documents/ingest`;
372
+
373
+ const response = await this.request({
374
+ path: urlPath,
375
+ method: 'POST',
376
+ headers: headerParameters,
377
+ query: queryParameters,
378
+ body: formParams,
379
+ }, initOverrides);
380
+
381
+ return new runtime.JSONApiResponse(response, (jsonValue) => IngestDocumentResponseFromJSON(jsonValue));
382
+ }
383
+
384
+ /**
385
+ * Upload a file, create document + version, and trigger ingestion workflow. Returns 201 with the Temporal workflow ID. Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
386
+ * Ingest Document Handler
387
+ */
388
+ async ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse> {
389
+ const response = await this.ingestDocumentRaw(requestParameters, initOverrides);
390
+ return await response.value();
391
+ }
392
+
393
+ /**
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.
292
395
  * List Documents Handler
293
396
  */
294
397
  async listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>> {
295
398
  const queryParameters: any = {};
296
399
 
297
- if (requestParameters['parentId'] != null) {
298
- queryParameters['parent_id'] = requestParameters['parentId'];
400
+ if (requestParameters['parentFolderId'] != null) {
401
+ queryParameters['parent_folder_id'] = requestParameters['parentFolderId'];
299
402
  }
300
403
 
301
404
  if (requestParameters['sortOrder'] != null) {
@@ -326,7 +429,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
326
429
  }
327
430
 
328
431
  /**
329
- * 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.
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.
330
433
  * List Documents Handler
331
434
  */
332
435
  async listDocuments(requestParameters: ListDocumentsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse> {
@@ -335,7 +438,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
335
438
  }
336
439
 
337
440
  /**
338
- * 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.
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.
339
442
  * Update Document Handler
340
443
  */
341
444
  async updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>> {
@@ -375,7 +478,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
375
478
  }
376
479
 
377
480
  /**
378
- * 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.
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.
379
482
  * Update Document Handler
380
483
  */
381
484
  async updateDocument(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse> {
@@ -65,7 +65,7 @@ export interface ListFolderContentsRequest {
65
65
  }
66
66
 
67
67
  export interface ListFoldersRequest {
68
- parentId?: string;
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 parent_id is not provided, lists folders in the root folder.
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} [parentId] Parent folder PathPart ID (defaults to root)
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 parent_id is not provided, lists folders in the root folder.
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 `parent_id` field. Both can be done in a single request.
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 `parent_id` field. Both can be done in a single request.
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 parent_id is not provided, lists folders in the root folder.
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['parentId'] != null) {
386
- queryParameters['parent_id'] = requestParameters['parentId'];
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 parent_id is not provided, lists folders in the root folder.
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 `parent_id` field. Both can be done in a single request.
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 `parent_id` field. Both can be done in a single request.
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> {
@@ -96,7 +96,7 @@ export interface TenantsApiInterface {
96
96
  createTenant(requestParameters: CreateTenantOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantResponse>;
97
97
 
98
98
  /**
99
- * Delete a tenant. Requires OWNER role in the tenant.
99
+ * Delete a tenant. Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
100
100
  * @summary Delete Tenant
101
101
  * @param {string} tenantId
102
102
  * @param {string} [ksUat]
@@ -107,7 +107,7 @@ export interface TenantsApiInterface {
107
107
  deleteTenantRaw(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
108
108
 
109
109
  /**
110
- * Delete a tenant. Requires OWNER role in the tenant.
110
+ * Delete a tenant. Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
111
111
  * Delete Tenant
112
112
  */
113
113
  deleteTenant(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -233,7 +233,7 @@ export class TenantsApi extends runtime.BaseAPI implements TenantsApiInterface {
233
233
  }
234
234
 
235
235
  /**
236
- * Delete a tenant. Requires OWNER role in the tenant.
236
+ * Delete a tenant. Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
237
237
  * Delete Tenant
238
238
  */
239
239
  async deleteTenantRaw(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -263,7 +263,7 @@ export class TenantsApi extends runtime.BaseAPI implements TenantsApiInterface {
263
263
  }
264
264
 
265
265
  /**
266
- * Delete a tenant. Requires OWNER role in the tenant.
266
+ * Delete a tenant. Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
267
267
  * Delete Tenant
268
268
  */
269
269
  async deleteTenant(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {