@knowledge-stack/ksapi 1.20.1 → 1.22.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 (68) hide show
  1. package/.openapi-generator/FILES +2 -1
  2. package/README.md +2 -2
  3. package/dist/apis/DocumentsApi.d.ts +4 -0
  4. package/dist/apis/DocumentsApi.js +6 -0
  5. package/dist/apis/FoldersApi.d.ts +10 -4
  6. package/dist/apis/FoldersApi.js +11 -2
  7. package/dist/apis/PathPartsApi.d.ts +67 -5
  8. package/dist/apis/PathPartsApi.js +76 -2
  9. package/dist/apis/TagsApi.d.ts +1 -63
  10. package/dist/apis/TagsApi.js +0 -72
  11. package/dist/apis/ThreadsApi.d.ts +33 -0
  12. package/dist/apis/ThreadsApi.js +37 -0
  13. package/dist/esm/apis/DocumentsApi.d.ts +4 -0
  14. package/dist/esm/apis/DocumentsApi.js +6 -0
  15. package/dist/esm/apis/FoldersApi.d.ts +10 -4
  16. package/dist/esm/apis/FoldersApi.js +11 -2
  17. package/dist/esm/apis/PathPartsApi.d.ts +67 -5
  18. package/dist/esm/apis/PathPartsApi.js +77 -3
  19. package/dist/esm/apis/TagsApi.d.ts +1 -63
  20. package/dist/esm/apis/TagsApi.js +1 -73
  21. package/dist/esm/apis/ThreadsApi.d.ts +33 -0
  22. package/dist/esm/apis/ThreadsApi.js +37 -0
  23. package/dist/esm/models/BulkTagRequest.d.ts +47 -0
  24. package/dist/esm/models/BulkTagRequest.js +49 -0
  25. package/dist/esm/models/DocumentResponse.d.ts +7 -0
  26. package/dist/esm/models/DocumentResponse.js +3 -0
  27. package/dist/esm/models/FolderDocumentResponse.d.ts +7 -0
  28. package/dist/esm/models/FolderDocumentResponse.js +3 -0
  29. package/dist/esm/models/FolderResponse.d.ts +7 -0
  30. package/dist/esm/models/FolderResponse.js +3 -0
  31. package/dist/esm/models/PathPartResponse.d.ts +7 -0
  32. package/dist/esm/models/PathPartResponse.js +3 -0
  33. package/dist/esm/models/PathPartTagsResponse.d.ts +48 -0
  34. package/dist/esm/models/PathPartTagsResponse.js +45 -0
  35. package/dist/esm/models/index.d.ts +2 -1
  36. package/dist/esm/models/index.js +2 -1
  37. package/dist/models/BulkTagRequest.d.ts +47 -0
  38. package/dist/models/BulkTagRequest.js +57 -0
  39. package/dist/models/DocumentResponse.d.ts +7 -0
  40. package/dist/models/DocumentResponse.js +3 -0
  41. package/dist/models/FolderDocumentResponse.d.ts +7 -0
  42. package/dist/models/FolderDocumentResponse.js +3 -0
  43. package/dist/models/FolderResponse.d.ts +7 -0
  44. package/dist/models/FolderResponse.js +3 -0
  45. package/dist/models/PathPartResponse.d.ts +7 -0
  46. package/dist/models/PathPartResponse.js +3 -0
  47. package/dist/models/PathPartTagsResponse.d.ts +48 -0
  48. package/dist/models/PathPartTagsResponse.js +53 -0
  49. package/dist/models/index.d.ts +2 -1
  50. package/dist/models/index.js +2 -1
  51. package/package.json +1 -1
  52. package/src/apis/DocumentsApi.ts +12 -0
  53. package/src/apis/FoldersApi.ts +22 -4
  54. package/src/apis/PathPartsApi.ts +156 -4
  55. package/src/apis/TagsApi.ts +0 -146
  56. package/src/apis/ThreadsApi.ts +72 -0
  57. package/src/models/BulkTagRequest.ts +87 -0
  58. package/src/models/DocumentResponse.ts +15 -0
  59. package/src/models/FolderDocumentResponse.ts +15 -0
  60. package/src/models/FolderResponse.ts +16 -0
  61. package/src/models/PathPartResponse.ts +15 -0
  62. package/src/models/PathPartTagsResponse.ts +91 -0
  63. package/src/models/index.ts +2 -1
  64. package/dist/esm/models/TagPathPartRequest.d.ts +0 -47
  65. package/dist/esm/models/TagPathPartRequest.js +0 -44
  66. package/dist/models/TagPathPartRequest.d.ts +0 -47
  67. package/dist/models/TagPathPartRequest.js +0 -52
  68. package/src/models/TagPathPartRequest.ts +0 -83
@@ -0,0 +1,57 @@
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
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.BulkTagRequestPropertyValidationAttributesMap = void 0;
17
+ exports.instanceOfBulkTagRequest = instanceOfBulkTagRequest;
18
+ exports.BulkTagRequestFromJSON = BulkTagRequestFromJSON;
19
+ exports.BulkTagRequestFromJSONTyped = BulkTagRequestFromJSONTyped;
20
+ exports.BulkTagRequestToJSON = BulkTagRequestToJSON;
21
+ exports.BulkTagRequestToJSONTyped = BulkTagRequestToJSONTyped;
22
+ /**
23
+ * Check if a given object implements the BulkTagRequest interface.
24
+ */
25
+ function instanceOfBulkTagRequest(value) {
26
+ if (!('tagIds' in value) || value['tagIds'] === undefined)
27
+ return false;
28
+ return true;
29
+ }
30
+ function BulkTagRequestFromJSON(json) {
31
+ return BulkTagRequestFromJSONTyped(json, false);
32
+ }
33
+ function BulkTagRequestFromJSONTyped(json, ignoreDiscriminator) {
34
+ if (json == null) {
35
+ return json;
36
+ }
37
+ return {
38
+ 'tagIds': json['tag_ids'],
39
+ };
40
+ }
41
+ function BulkTagRequestToJSON(json) {
42
+ return BulkTagRequestToJSONTyped(json, false);
43
+ }
44
+ function BulkTagRequestToJSONTyped(value, ignoreDiscriminator = false) {
45
+ if (value == null) {
46
+ return value;
47
+ }
48
+ return {
49
+ 'tag_ids': value['tagIds'],
50
+ };
51
+ }
52
+ exports.BulkTagRequestPropertyValidationAttributesMap = {
53
+ tagIds: {
54
+ maxItems: 10,
55
+ uniqueItems: false,
56
+ },
57
+ };
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { DocumentOrigin } from './DocumentOrigin';
13
+ import type { TagResponse } from './TagResponse';
13
14
  import type { DocumentType } from './DocumentType';
14
15
  import type { DocumentVersionResponse } from './DocumentVersionResponse';
15
16
  /**
@@ -96,6 +97,12 @@ export interface DocumentResponse {
96
97
  * @memberof DocumentResponse
97
98
  */
98
99
  updatedAt: Date;
100
+ /**
101
+ * Tags attached to this document
102
+ * @type {Array<TagResponse>}
103
+ * @memberof DocumentResponse
104
+ */
105
+ tags?: Array<TagResponse> | null;
99
106
  }
100
107
  /**
101
108
  * Check if a given object implements the DocumentResponse interface.
@@ -20,6 +20,7 @@ exports.DocumentResponseFromJSONTyped = DocumentResponseFromJSONTyped;
20
20
  exports.DocumentResponseToJSON = DocumentResponseToJSON;
21
21
  exports.DocumentResponseToJSONTyped = DocumentResponseToJSONTyped;
22
22
  const DocumentOrigin_1 = require("./DocumentOrigin");
23
+ const TagResponse_1 = require("./TagResponse");
23
24
  const DocumentType_1 = require("./DocumentType");
24
25
  const DocumentVersionResponse_1 = require("./DocumentVersionResponse");
25
26
  /**
@@ -75,6 +76,7 @@ function DocumentResponseFromJSONTyped(json, ignoreDiscriminator) {
75
76
  'tenantId': json['tenant_id'],
76
77
  'createdAt': (new Date(json['created_at'])),
77
78
  'updatedAt': (new Date(json['updated_at'])),
79
+ 'tags': json['tags'] == null ? undefined : (json['tags'].map(TagResponse_1.TagResponseFromJSON)),
78
80
  };
79
81
  }
80
82
  function DocumentResponseToJSON(json) {
@@ -98,6 +100,7 @@ function DocumentResponseToJSONTyped(value, ignoreDiscriminator = false) {
98
100
  'tenant_id': value['tenantId'],
99
101
  'created_at': value['createdAt'].toISOString(),
100
102
  'updated_at': value['updatedAt'].toISOString(),
103
+ 'tags': value['tags'] == null ? undefined : (value['tags'].map(TagResponse_1.TagResponseToJSON)),
101
104
  };
102
105
  }
103
106
  exports.DocumentResponsePropertyValidationAttributesMap = {};
@@ -11,6 +11,7 @@
11
11
  */
12
12
  import type { DocumentOrigin } from './DocumentOrigin';
13
13
  import type { PartType } from './PartType';
14
+ import type { TagResponse } from './TagResponse';
14
15
  import type { DocumentType } from './DocumentType';
15
16
  import type { DocumentVersionResponse } from './DocumentVersionResponse';
16
17
  /**
@@ -70,6 +71,12 @@ export interface FolderDocumentResponse {
70
71
  * @memberof FolderDocumentResponse
71
72
  */
72
73
  systemManaged: boolean;
74
+ /**
75
+ * Tags attached to this path part
76
+ * @type {Array<TagResponse>}
77
+ * @memberof FolderDocumentResponse
78
+ */
79
+ tags?: Array<TagResponse> | null;
73
80
  /**
74
81
  * Creation timestamp
75
82
  * @type {Date}
@@ -21,6 +21,7 @@ exports.FolderDocumentResponseToJSON = FolderDocumentResponseToJSON;
21
21
  exports.FolderDocumentResponseToJSONTyped = FolderDocumentResponseToJSONTyped;
22
22
  const DocumentOrigin_1 = require("./DocumentOrigin");
23
23
  const PartType_1 = require("./PartType");
24
+ const TagResponse_1 = require("./TagResponse");
24
25
  const DocumentType_1 = require("./DocumentType");
25
26
  const DocumentVersionResponse_1 = require("./DocumentVersionResponse");
26
27
  /**
@@ -64,6 +65,7 @@ function FolderDocumentResponseFromJSONTyped(json, ignoreDiscriminator) {
64
65
  'metadataObjId': json['metadata_obj_id'],
65
66
  'materializedPath': json['materialized_path'],
66
67
  'systemManaged': json['system_managed'],
68
+ 'tags': json['tags'] == null ? undefined : (json['tags'].map(TagResponse_1.TagResponseFromJSON)),
67
69
  'createdAt': (new Date(json['created_at'])),
68
70
  'updatedAt': (new Date(json['updated_at'])),
69
71
  'folderId': json['folder_id'] == null ? undefined : json['folder_id'],
@@ -90,6 +92,7 @@ function FolderDocumentResponseToJSONTyped(value, ignoreDiscriminator = false) {
90
92
  'metadata_obj_id': value['metadataObjId'],
91
93
  'materialized_path': value['materializedPath'],
92
94
  'system_managed': value['systemManaged'],
95
+ 'tags': value['tags'] == null ? undefined : (value['tags'].map(TagResponse_1.TagResponseToJSON)),
93
96
  'created_at': value['createdAt'].toISOString(),
94
97
  'updated_at': value['updatedAt'].toISOString(),
95
98
  'folder_id': value['folderId'],
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { TagResponse } from './TagResponse';
12
13
  /**
13
14
  * Folder response model.
14
15
  * @export
@@ -69,6 +70,12 @@ export interface FolderResponse {
69
70
  * @memberof FolderResponse
70
71
  */
71
72
  updatedAt: Date;
73
+ /**
74
+ * Tags attached to this folder
75
+ * @type {Array<TagResponse>}
76
+ * @memberof FolderResponse
77
+ */
78
+ tags?: Array<TagResponse> | null;
72
79
  }
73
80
  /**
74
81
  * Check if a given object implements the FolderResponse interface.
@@ -19,6 +19,7 @@ exports.FolderResponseFromJSON = FolderResponseFromJSON;
19
19
  exports.FolderResponseFromJSONTyped = FolderResponseFromJSONTyped;
20
20
  exports.FolderResponseToJSON = FolderResponseToJSON;
21
21
  exports.FolderResponseToJSONTyped = FolderResponseToJSONTyped;
22
+ const TagResponse_1 = require("./TagResponse");
22
23
  /**
23
24
  * Check if a given object implements the FolderResponse interface.
24
25
  */
@@ -60,6 +61,7 @@ function FolderResponseFromJSONTyped(json, ignoreDiscriminator) {
60
61
  'tenantId': json['tenant_id'],
61
62
  'createdAt': (new Date(json['created_at'])),
62
63
  'updatedAt': (new Date(json['updated_at'])),
64
+ 'tags': json['tags'] == null ? undefined : (json['tags'].map(TagResponse_1.TagResponseFromJSON)),
63
65
  };
64
66
  }
65
67
  function FolderResponseToJSON(json) {
@@ -79,6 +81,7 @@ function FolderResponseToJSONTyped(value, ignoreDiscriminator = false) {
79
81
  'tenant_id': value['tenantId'],
80
82
  'created_at': value['createdAt'].toISOString(),
81
83
  'updated_at': value['updatedAt'].toISOString(),
84
+ 'tags': value['tags'] == null ? undefined : (value['tags'].map(TagResponse_1.TagResponseToJSON)),
82
85
  };
83
86
  }
84
87
  exports.FolderResponsePropertyValidationAttributesMap = {};
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { PartType } from './PartType';
13
+ import type { TagResponse } from './TagResponse';
13
14
  /**
14
15
  * Generic path part response model.
15
16
  * @export
@@ -58,6 +59,12 @@ export interface PathPartResponse {
58
59
  * @memberof PathPartResponse
59
60
  */
60
61
  systemManaged: boolean;
62
+ /**
63
+ * Tags attached to this path part
64
+ * @type {Array<TagResponse>}
65
+ * @memberof PathPartResponse
66
+ */
67
+ tags?: Array<TagResponse> | null;
61
68
  /**
62
69
  * Creation timestamp
63
70
  * @type {Date}
@@ -20,6 +20,7 @@ exports.PathPartResponseFromJSONTyped = PathPartResponseFromJSONTyped;
20
20
  exports.PathPartResponseToJSON = PathPartResponseToJSON;
21
21
  exports.PathPartResponseToJSONTyped = PathPartResponseToJSONTyped;
22
22
  const PartType_1 = require("./PartType");
23
+ const TagResponse_1 = require("./TagResponse");
23
24
  /**
24
25
  * Check if a given object implements the PathPartResponse interface.
25
26
  */
@@ -59,6 +60,7 @@ function PathPartResponseFromJSONTyped(json, ignoreDiscriminator) {
59
60
  'metadataObjId': json['metadata_obj_id'],
60
61
  'materializedPath': json['materialized_path'],
61
62
  'systemManaged': json['system_managed'],
63
+ 'tags': json['tags'] == null ? undefined : (json['tags'].map(TagResponse_1.TagResponseFromJSON)),
62
64
  'createdAt': (new Date(json['created_at'])),
63
65
  'updatedAt': (new Date(json['updated_at'])),
64
66
  };
@@ -78,6 +80,7 @@ function PathPartResponseToJSONTyped(value, ignoreDiscriminator = false) {
78
80
  'metadata_obj_id': value['metadataObjId'],
79
81
  'materialized_path': value['materializedPath'],
80
82
  'system_managed': value['systemManaged'],
83
+ 'tags': value['tags'] == null ? undefined : (value['tags'].map(TagResponse_1.TagResponseToJSON)),
81
84
  'created_at': value['createdAt'].toISOString(),
82
85
  'updated_at': value['updatedAt'].toISOString(),
83
86
  };
@@ -0,0 +1,48 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { TagResponse } from './TagResponse';
13
+ /**
14
+ * Response containing the current tags for a path part.
15
+ * @export
16
+ * @interface PathPartTagsResponse
17
+ */
18
+ export interface PathPartTagsResponse {
19
+ /**
20
+ * Tags attached to the path part
21
+ * @type {Array<TagResponse>}
22
+ * @memberof PathPartTagsResponse
23
+ */
24
+ tags: Array<TagResponse>;
25
+ }
26
+ /**
27
+ * Check if a given object implements the PathPartTagsResponse interface.
28
+ */
29
+ export declare function instanceOfPathPartTagsResponse(value: object): value is PathPartTagsResponse;
30
+ export declare function PathPartTagsResponseFromJSON(json: any): PathPartTagsResponse;
31
+ export declare function PathPartTagsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PathPartTagsResponse;
32
+ export declare function PathPartTagsResponseToJSON(json: any): PathPartTagsResponse;
33
+ export declare function PathPartTagsResponseToJSONTyped(value?: PathPartTagsResponse | null, ignoreDiscriminator?: boolean): any;
34
+ export declare const PathPartTagsResponsePropertyValidationAttributesMap: {
35
+ [property: string]: {
36
+ maxLength?: number;
37
+ minLength?: number;
38
+ pattern?: string;
39
+ maximum?: number;
40
+ exclusiveMaximum?: boolean;
41
+ minimum?: number;
42
+ exclusiveMinimum?: boolean;
43
+ multipleOf?: number;
44
+ maxItems?: number;
45
+ minItems?: number;
46
+ uniqueItems?: boolean;
47
+ };
48
+ };
@@ -0,0 +1,53 @@
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
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.PathPartTagsResponsePropertyValidationAttributesMap = void 0;
17
+ exports.instanceOfPathPartTagsResponse = instanceOfPathPartTagsResponse;
18
+ exports.PathPartTagsResponseFromJSON = PathPartTagsResponseFromJSON;
19
+ exports.PathPartTagsResponseFromJSONTyped = PathPartTagsResponseFromJSONTyped;
20
+ exports.PathPartTagsResponseToJSON = PathPartTagsResponseToJSON;
21
+ exports.PathPartTagsResponseToJSONTyped = PathPartTagsResponseToJSONTyped;
22
+ const TagResponse_1 = require("./TagResponse");
23
+ /**
24
+ * Check if a given object implements the PathPartTagsResponse interface.
25
+ */
26
+ function instanceOfPathPartTagsResponse(value) {
27
+ if (!('tags' in value) || value['tags'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ function PathPartTagsResponseFromJSON(json) {
32
+ return PathPartTagsResponseFromJSONTyped(json, false);
33
+ }
34
+ function PathPartTagsResponseFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'tags': (json['tags'].map(TagResponse_1.TagResponseFromJSON)),
40
+ };
41
+ }
42
+ function PathPartTagsResponseToJSON(json) {
43
+ return PathPartTagsResponseToJSONTyped(json, false);
44
+ }
45
+ function PathPartTagsResponseToJSONTyped(value, ignoreDiscriminator = false) {
46
+ if (value == null) {
47
+ return value;
48
+ }
49
+ return {
50
+ 'tags': (value['tags'].map(TagResponse_1.TagResponseToJSON)),
51
+ };
52
+ }
53
+ exports.PathPartTagsResponsePropertyValidationAttributesMap = {};
@@ -1,3 +1,4 @@
1
+ export * from './BulkTagRequest';
1
2
  export * from './ChunkLineageResponse';
2
3
  export * from './ChunkMetadataInput';
3
4
  export * from './ChunkMetadataOutput';
@@ -60,6 +61,7 @@ export * from './PasswordResetRequest';
60
61
  export * from './PasswordResetWithTokenRequest';
61
62
  export * from './PathOrder';
62
63
  export * from './PathPartResponse';
64
+ export * from './PathPartTagsResponse';
63
65
  export * from './PermissionCapability';
64
66
  export * from './PermissionResponse';
65
67
  export * from './PipelineState';
@@ -70,7 +72,6 @@ export * from './RootResponse';
70
72
  export * from './ScoredChunkResponse';
71
73
  export * from './SectionResponse';
72
74
  export * from './SignInRequest';
73
- export * from './TagPathPartRequest';
74
75
  export * from './TagResponse';
75
76
  export * from './TenantResponse';
76
77
  export * from './TenantUserInTenantResponse';
@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  /* tslint:disable */
18
18
  /* eslint-disable */
19
+ __exportStar(require("./BulkTagRequest"), exports);
19
20
  __exportStar(require("./ChunkLineageResponse"), exports);
20
21
  __exportStar(require("./ChunkMetadataInput"), exports);
21
22
  __exportStar(require("./ChunkMetadataOutput"), exports);
@@ -78,6 +79,7 @@ __exportStar(require("./PasswordResetRequest"), exports);
78
79
  __exportStar(require("./PasswordResetWithTokenRequest"), exports);
79
80
  __exportStar(require("./PathOrder"), exports);
80
81
  __exportStar(require("./PathPartResponse"), exports);
82
+ __exportStar(require("./PathPartTagsResponse"), exports);
81
83
  __exportStar(require("./PermissionCapability"), exports);
82
84
  __exportStar(require("./PermissionResponse"), exports);
83
85
  __exportStar(require("./PipelineState"), exports);
@@ -88,7 +90,6 @@ __exportStar(require("./RootResponse"), exports);
88
90
  __exportStar(require("./ScoredChunkResponse"), exports);
89
91
  __exportStar(require("./SectionResponse"), exports);
90
92
  __exportStar(require("./SignInRequest"), exports);
91
- __exportStar(require("./TagPathPartRequest"), exports);
92
93
  __exportStar(require("./TagResponse"), exports);
93
94
  __exportStar(require("./TenantResponse"), exports);
94
95
  __exportStar(require("./TenantUserInTenantResponse"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowledge-stack/ksapi",
3
- "version": "1.20.1",
3
+ "version": "1.22.0",
4
4
  "description": "OpenAPI client for @knowledge-stack/ksapi",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -52,6 +52,7 @@ export interface DeleteDocumentRequest {
52
52
 
53
53
  export interface GetDocumentRequest {
54
54
  documentId: string;
55
+ withTags?: boolean;
55
56
  ksUat?: string | null;
56
57
  }
57
58
 
@@ -65,6 +66,7 @@ export interface IngestDocumentRequest {
65
66
  export interface ListDocumentsRequest {
66
67
  parentPathPartId?: string | null;
67
68
  sortOrder?: PathOrder;
69
+ withTags?: boolean;
68
70
  limit?: number;
69
71
  offset?: number;
70
72
  ksUat?: string | null;
@@ -121,6 +123,7 @@ export interface DocumentsApiInterface {
121
123
  * Get a document by its document ID.
122
124
  * @summary Get Document Handler
123
125
  * @param {string} documentId
126
+ * @param {boolean} [withTags] Include tags in the response (default: false)
124
127
  * @param {string} [ksUat]
125
128
  * @param {*} [options] Override http request option.
126
129
  * @throws {RequiredError}
@@ -158,6 +161,7 @@ export interface DocumentsApiInterface {
158
161
  * @summary List Documents Handler
159
162
  * @param {string} [parentPathPartId] Parent PathPart ID (defaults to root)
160
163
  * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
164
+ * @param {boolean} [withTags] Include tags in the response (default: false)
161
165
  * @param {number} [limit] Number of items per page
162
166
  * @param {number} [offset] Number of items to skip
163
167
  * @param {string} [ksUat]
@@ -291,6 +295,10 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
291
295
 
292
296
  const queryParameters: any = {};
293
297
 
298
+ if (requestParameters['withTags'] != null) {
299
+ queryParameters['with_tags'] = requestParameters['withTags'];
300
+ }
301
+
294
302
  const headerParameters: runtime.HTTPHeaders = {};
295
303
 
296
304
 
@@ -405,6 +413,10 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
405
413
  queryParameters['sort_order'] = requestParameters['sortOrder'];
406
414
  }
407
415
 
416
+ if (requestParameters['withTags'] != null) {
417
+ queryParameters['with_tags'] = requestParameters['withTags'];
418
+ }
419
+
408
420
  if (requestParameters['limit'] != null) {
409
421
  queryParameters['limit'] = requestParameters['limit'];
410
422
  }
@@ -52,6 +52,7 @@ export interface DeleteFolderRequest {
52
52
 
53
53
  export interface GetFolderRequest {
54
54
  folderId: string;
55
+ withTags?: boolean;
55
56
  ksUat?: string | null;
56
57
  }
57
58
 
@@ -59,6 +60,7 @@ export interface ListFolderContentsRequest {
59
60
  folderId: string;
60
61
  maxDepth?: number;
61
62
  sortOrder?: PathOrder;
63
+ withTags?: boolean;
62
64
  limit?: number;
63
65
  offset?: number;
64
66
  ksUat?: string | null;
@@ -67,6 +69,7 @@ export interface ListFolderContentsRequest {
67
69
  export interface ListFoldersRequest {
68
70
  parentPathPartId?: string | null;
69
71
  sortOrder?: PathOrder;
72
+ withTags?: boolean;
70
73
  limit?: number;
71
74
  offset?: number;
72
75
  ksUat?: string | null;
@@ -123,6 +126,7 @@ export interface FoldersApiInterface {
123
126
  * Get a folder by its folder ID.
124
127
  * @summary Get Folder Handler
125
128
  * @param {string} folderId
129
+ * @param {boolean} [withTags] Include tags in the response (default: false)
126
130
  * @param {string} [ksUat]
127
131
  * @param {*} [options] Override http request option.
128
132
  * @throws {RequiredError}
@@ -137,11 +141,12 @@ export interface FoldersApiInterface {
137
141
  getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
138
142
 
139
143
  /**
140
- * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
144
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
141
145
  * @summary List Folder Contents Handler
142
146
  * @param {string} folderId
143
147
  * @param {number} [maxDepth] Maximum depth to traverse (1&#x3D;direct children, default: 1)
144
148
  * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
149
+ * @param {boolean} [withTags] Include tag IDs for each item (default: false)
145
150
  * @param {number} [limit] Number of items per page
146
151
  * @param {number} [offset] Number of items to skip
147
152
  * @param {string} [ksUat]
@@ -152,7 +157,7 @@ export interface FoldersApiInterface {
152
157
  listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderDocumentResponse>>;
153
158
 
154
159
  /**
155
- * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
160
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
156
161
  * List Folder Contents Handler
157
162
  */
158
163
  listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
@@ -162,6 +167,7 @@ export interface FoldersApiInterface {
162
167
  * @summary List Folders Handler
163
168
  * @param {string} [parentPathPartId] Parent PathPart ID (defaults to root)
164
169
  * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
170
+ * @param {boolean} [withTags] Include tags in the response (default: false)
165
171
  * @param {number} [limit] Number of items per page
166
172
  * @param {number} [offset] Number of items to skip
167
173
  * @param {string} [ksUat]
@@ -295,6 +301,10 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
295
301
 
296
302
  const queryParameters: any = {};
297
303
 
304
+ if (requestParameters['withTags'] != null) {
305
+ queryParameters['with_tags'] = requestParameters['withTags'];
306
+ }
307
+
298
308
  const headerParameters: runtime.HTTPHeaders = {};
299
309
 
300
310
 
@@ -321,7 +331,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
321
331
  }
322
332
 
323
333
  /**
324
- * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
334
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
325
335
  * List Folder Contents Handler
326
336
  */
327
337
  async listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderDocumentResponse>> {
@@ -342,6 +352,10 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
342
352
  queryParameters['sort_order'] = requestParameters['sortOrder'];
343
353
  }
344
354
 
355
+ if (requestParameters['withTags'] != null) {
356
+ queryParameters['with_tags'] = requestParameters['withTags'];
357
+ }
358
+
345
359
  if (requestParameters['limit'] != null) {
346
360
  queryParameters['limit'] = requestParameters['limit'];
347
361
  }
@@ -367,7 +381,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
367
381
  }
368
382
 
369
383
  /**
370
- * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
384
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
371
385
  * List Folder Contents Handler
372
386
  */
373
387
  async listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse> {
@@ -390,6 +404,10 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
390
404
  queryParameters['sort_order'] = requestParameters['sortOrder'];
391
405
  }
392
406
 
407
+ if (requestParameters['withTags'] != null) {
408
+ queryParameters['with_tags'] = requestParameters['withTags'];
409
+ }
410
+
393
411
  if (requestParameters['limit'] != null) {
394
412
  queryParameters['limit'] = requestParameters['limit'];
395
413
  }