@knowledge-stack/ksapi 1.8.0 → 1.10.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.
- package/.openapi-generator/FILES +14 -0
- package/README.md +2 -2
- package/dist/apis/DocumentVersionsApi.d.ts +36 -1
- package/dist/apis/DocumentVersionsApi.js +41 -0
- package/dist/apis/FoldersApi.d.ts +38 -1
- package/dist/apis/FoldersApi.js +44 -0
- package/dist/apis/PathPartsApi.d.ts +4 -6
- package/dist/apis/PathPartsApi.js +2 -5
- package/dist/apis/ThreadMessagesApi.d.ts +123 -0
- package/dist/apis/ThreadMessagesApi.js +147 -0
- package/dist/apis/ThreadsApi.d.ts +177 -0
- package/dist/apis/ThreadsApi.js +203 -0
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +2 -0
- package/dist/esm/apis/DocumentVersionsApi.d.ts +36 -1
- package/dist/esm/apis/DocumentVersionsApi.js +42 -1
- package/dist/esm/apis/FoldersApi.d.ts +38 -1
- package/dist/esm/apis/FoldersApi.js +45 -1
- package/dist/esm/apis/PathPartsApi.d.ts +4 -6
- package/dist/esm/apis/PathPartsApi.js +2 -5
- package/dist/esm/apis/ThreadMessagesApi.d.ts +123 -0
- package/dist/esm/apis/ThreadMessagesApi.js +143 -0
- package/dist/esm/apis/ThreadsApi.d.ts +177 -0
- package/dist/esm/apis/ThreadsApi.js +199 -0
- package/dist/esm/apis/index.d.ts +2 -0
- package/dist/esm/apis/index.js +2 -0
- package/dist/esm/models/CreateThreadMessageRequest.d.ts +58 -0
- package/dist/esm/models/CreateThreadMessageRequest.js +50 -0
- package/dist/esm/models/CreateThreadRequest.d.ts +53 -0
- package/dist/esm/models/CreateThreadRequest.js +49 -0
- package/dist/esm/models/DocumentContentPathPart.d.ts +119 -0
- package/dist/esm/models/DocumentContentPathPart.js +83 -0
- package/dist/esm/models/FolderDocumentResponse.d.ts +138 -0
- package/dist/esm/models/FolderDocumentResponse.js +88 -0
- package/dist/esm/models/MessageRole.d.ts +26 -0
- package/dist/esm/models/MessageRole.js +44 -0
- package/dist/esm/models/PaginatedResponseDocumentContentPathPart.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseDocumentContentPathPart.js +70 -0
- package/dist/esm/models/PaginatedResponseFolderDocumentResponse.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseFolderDocumentResponse.js +70 -0
- package/dist/esm/models/PaginatedResponseThreadMessageResponse.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseThreadMessageResponse.js +70 -0
- package/dist/esm/models/PaginatedResponseThreadResponse.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseThreadResponse.js +70 -0
- package/dist/esm/models/ThreadMessageResponse.d.ts +100 -0
- package/dist/esm/models/ThreadMessageResponse.js +78 -0
- package/dist/esm/models/ThreadResponse.d.ts +83 -0
- package/dist/esm/models/ThreadResponse.js +66 -0
- package/dist/esm/models/UpdateThreadRequest.d.ts +53 -0
- package/dist/esm/models/UpdateThreadRequest.js +49 -0
- package/dist/esm/models/index.d.ts +12 -0
- package/dist/esm/models/index.js +12 -0
- package/dist/models/CreateThreadMessageRequest.d.ts +58 -0
- package/dist/models/CreateThreadMessageRequest.js +58 -0
- package/dist/models/CreateThreadRequest.d.ts +53 -0
- package/dist/models/CreateThreadRequest.js +57 -0
- package/dist/models/DocumentContentPathPart.d.ts +119 -0
- package/dist/models/DocumentContentPathPart.js +91 -0
- package/dist/models/FolderDocumentResponse.d.ts +138 -0
- package/dist/models/FolderDocumentResponse.js +96 -0
- package/dist/models/MessageRole.d.ts +26 -0
- package/dist/models/MessageRole.js +52 -0
- package/dist/models/PaginatedResponseDocumentContentPathPart.d.ts +66 -0
- package/dist/models/PaginatedResponseDocumentContentPathPart.js +78 -0
- package/dist/models/PaginatedResponseFolderDocumentResponse.d.ts +66 -0
- package/dist/models/PaginatedResponseFolderDocumentResponse.js +78 -0
- package/dist/models/PaginatedResponseThreadMessageResponse.d.ts +66 -0
- package/dist/models/PaginatedResponseThreadMessageResponse.js +78 -0
- package/dist/models/PaginatedResponseThreadResponse.d.ts +66 -0
- package/dist/models/PaginatedResponseThreadResponse.js +78 -0
- package/dist/models/ThreadMessageResponse.d.ts +100 -0
- package/dist/models/ThreadMessageResponse.js +86 -0
- package/dist/models/ThreadResponse.d.ts +83 -0
- package/dist/models/ThreadResponse.js +74 -0
- package/dist/models/UpdateThreadRequest.d.ts +53 -0
- package/dist/models/UpdateThreadRequest.js +57 -0
- package/dist/models/index.d.ts +12 -0
- package/dist/models/index.js +12 -0
- package/package.json +1 -1
- package/src/apis/DocumentVersionsApi.ts +82 -0
- package/src/apis/FoldersApi.ts +88 -0
- package/src/apis/PathPartsApi.ts +4 -10
- package/src/apis/ThreadMessagesApi.ts +271 -0
- package/src/apis/ThreadsApi.ts +377 -0
- package/src/apis/index.ts +2 -0
- package/src/models/CreateThreadMessageRequest.ts +105 -0
- package/src/models/CreateThreadRequest.ts +94 -0
- package/src/models/DocumentContentPathPart.ts +205 -0
- package/src/models/FolderDocumentResponse.ts +234 -0
- package/src/models/MessageRole.ts +54 -0
- package/src/models/PaginatedResponseDocumentContentPathPart.ts +130 -0
- package/src/models/PaginatedResponseFolderDocumentResponse.ts +130 -0
- package/src/models/PaginatedResponseThreadMessageResponse.ts +130 -0
- package/src/models/PaginatedResponseThreadResponse.ts +130 -0
- package/src/models/ThreadMessageResponse.ts +168 -0
- package/src/models/ThreadResponse.ts +136 -0
- package/src/models/UpdateThreadRequest.ts +94 -0
- package/src/models/index.ts +12 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -13,6 +13,8 @@ src/apis/InvitesApi.ts
|
|
|
13
13
|
src/apis/PathPartsApi.ts
|
|
14
14
|
src/apis/SectionsApi.ts
|
|
15
15
|
src/apis/TenantsApi.ts
|
|
16
|
+
src/apis/ThreadMessagesApi.ts
|
|
17
|
+
src/apis/ThreadsApi.ts
|
|
16
18
|
src/apis/UsersApi.ts
|
|
17
19
|
src/apis/index.ts
|
|
18
20
|
src/index.ts
|
|
@@ -26,12 +28,16 @@ src/models/CreateFolderRequest.ts
|
|
|
26
28
|
src/models/CreatePasswordUserRequest.ts
|
|
27
29
|
src/models/CreateSectionRequest.ts
|
|
28
30
|
src/models/CreateTenantRequest.ts
|
|
31
|
+
src/models/CreateThreadMessageRequest.ts
|
|
32
|
+
src/models/CreateThreadRequest.ts
|
|
33
|
+
src/models/DocumentContentPathPart.ts
|
|
29
34
|
src/models/DocumentOrigin.ts
|
|
30
35
|
src/models/DocumentResponse.ts
|
|
31
36
|
src/models/DocumentType.ts
|
|
32
37
|
src/models/DocumentVersionResponse.ts
|
|
33
38
|
src/models/EmailSentResponse.ts
|
|
34
39
|
src/models/EmailVerificationRequest.ts
|
|
40
|
+
src/models/FolderDocumentResponse.ts
|
|
35
41
|
src/models/FolderResponse.ts
|
|
36
42
|
src/models/HTTPValidationError.ts
|
|
37
43
|
src/models/HealthCheckResponse.ts
|
|
@@ -39,14 +45,19 @@ src/models/IdpType.ts
|
|
|
39
45
|
src/models/InviteResponse.ts
|
|
40
46
|
src/models/InviteStatus.ts
|
|
41
47
|
src/models/InviteUserRequest.ts
|
|
48
|
+
src/models/MessageRole.ts
|
|
42
49
|
src/models/OAuth2Config.ts
|
|
50
|
+
src/models/PaginatedResponseDocumentContentPathPart.ts
|
|
43
51
|
src/models/PaginatedResponseDocumentResponse.ts
|
|
44
52
|
src/models/PaginatedResponseDocumentVersionResponse.ts
|
|
53
|
+
src/models/PaginatedResponseFolderDocumentResponse.ts
|
|
45
54
|
src/models/PaginatedResponseFolderResponse.ts
|
|
46
55
|
src/models/PaginatedResponseInviteResponse.ts
|
|
47
56
|
src/models/PaginatedResponsePathPartResponse.ts
|
|
48
57
|
src/models/PaginatedResponseTenantResponse.ts
|
|
49
58
|
src/models/PaginatedResponseTenantUserInTenantResponse.ts
|
|
59
|
+
src/models/PaginatedResponseThreadMessageResponse.ts
|
|
60
|
+
src/models/PaginatedResponseThreadResponse.ts
|
|
50
61
|
src/models/PartType.ts
|
|
51
62
|
src/models/PasswordResetRequest.ts
|
|
52
63
|
src/models/PasswordResetWithTokenRequest.ts
|
|
@@ -60,12 +71,15 @@ src/models/SignInRequest.ts
|
|
|
60
71
|
src/models/TenantResponse.ts
|
|
61
72
|
src/models/TenantUserInTenantResponse.ts
|
|
62
73
|
src/models/TenantUserRole.ts
|
|
74
|
+
src/models/ThreadMessageResponse.ts
|
|
75
|
+
src/models/ThreadResponse.ts
|
|
63
76
|
src/models/UpdateChunkContentRequest.ts
|
|
64
77
|
src/models/UpdateChunkMetadataRequest.ts
|
|
65
78
|
src/models/UpdateDocumentRequest.ts
|
|
66
79
|
src/models/UpdateFolderRequest.ts
|
|
67
80
|
src/models/UpdateSectionRequest.ts
|
|
68
81
|
src/models/UpdateTenantRequest.ts
|
|
82
|
+
src/models/UpdateThreadRequest.ts
|
|
69
83
|
src/models/UpdateUserRequest.ts
|
|
70
84
|
src/models/UserResponse.ts
|
|
71
85
|
src/models/ValidationError.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @knowledge-stack/ksapi@1.
|
|
1
|
+
## @knowledge-stack/ksapi@1.10.0
|
|
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.
|
|
39
|
+
npm install @knowledge-stack/ksapi@1.10.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { DocumentVersionResponse, PaginatedResponseDocumentVersionResponse } from '../models/index';
|
|
13
|
+
import type { DocumentVersionResponse, PaginatedResponseDocumentContentPathPart, PaginatedResponseDocumentVersionResponse } from '../models/index';
|
|
14
14
|
export interface CreateDocumentVersionRequest {
|
|
15
15
|
documentId: string;
|
|
16
16
|
ksUat?: string;
|
|
@@ -23,6 +23,13 @@ export interface GetDocumentVersionRequest {
|
|
|
23
23
|
versionId: string;
|
|
24
24
|
ksUat?: string;
|
|
25
25
|
}
|
|
26
|
+
export interface GetDocumentVersionContentsRequest {
|
|
27
|
+
versionId: string;
|
|
28
|
+
sectionId?: string;
|
|
29
|
+
limit?: number;
|
|
30
|
+
offset?: number;
|
|
31
|
+
ksUat?: string;
|
|
32
|
+
}
|
|
26
33
|
export interface ListDocumentVersionsRequest {
|
|
27
34
|
documentId: string;
|
|
28
35
|
limit?: number;
|
|
@@ -81,6 +88,24 @@ export interface DocumentVersionsApiInterface {
|
|
|
81
88
|
* Get Document Version Handler
|
|
82
89
|
*/
|
|
83
90
|
getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
|
|
91
|
+
/**
|
|
92
|
+
* List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
|
|
93
|
+
* @summary Get Document Version Contents Handler
|
|
94
|
+
* @param {string} versionId DocumentVersion ID
|
|
95
|
+
* @param {string} [sectionId] Optional section ID to scope traversal to a subtree
|
|
96
|
+
* @param {number} [limit] Number of items per page
|
|
97
|
+
* @param {number} [offset] Number of items to skip
|
|
98
|
+
* @param {string} [ksUat]
|
|
99
|
+
* @param {*} [options] Override http request option.
|
|
100
|
+
* @throws {RequiredError}
|
|
101
|
+
* @memberof DocumentVersionsApiInterface
|
|
102
|
+
*/
|
|
103
|
+
getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentContentPathPart>>;
|
|
104
|
+
/**
|
|
105
|
+
* List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
|
|
106
|
+
* Get Document Version Contents Handler
|
|
107
|
+
*/
|
|
108
|
+
getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentContentPathPart>;
|
|
84
109
|
/**
|
|
85
110
|
* List all versions for a document. Returns versions ordered by version number ascending (v0, v1, v2...).
|
|
86
111
|
* @summary List Document Versions Handler
|
|
@@ -133,6 +158,16 @@ export declare class DocumentVersionsApi extends runtime.BaseAPI implements Docu
|
|
|
133
158
|
* Get Document Version Handler
|
|
134
159
|
*/
|
|
135
160
|
getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
|
|
161
|
+
/**
|
|
162
|
+
* List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
|
|
163
|
+
* Get Document Version Contents Handler
|
|
164
|
+
*/
|
|
165
|
+
getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentContentPathPart>>;
|
|
166
|
+
/**
|
|
167
|
+
* List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
|
|
168
|
+
* Get Document Version Contents Handler
|
|
169
|
+
*/
|
|
170
|
+
getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentContentPathPart>;
|
|
136
171
|
/**
|
|
137
172
|
* List all versions for a document. Returns versions ordered by version number ascending (v0, v1, v2...).
|
|
138
173
|
* List Document Versions Handler
|
|
@@ -124,6 +124,47 @@ class DocumentVersionsApi extends runtime.BaseAPI {
|
|
|
124
124
|
return yield response.value();
|
|
125
125
|
});
|
|
126
126
|
}
|
|
127
|
+
/**
|
|
128
|
+
* List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
|
|
129
|
+
* Get Document Version Contents Handler
|
|
130
|
+
*/
|
|
131
|
+
getDocumentVersionContentsRaw(requestParameters, initOverrides) {
|
|
132
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
133
|
+
if (requestParameters['versionId'] == null) {
|
|
134
|
+
throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling getDocumentVersionContents().');
|
|
135
|
+
}
|
|
136
|
+
const queryParameters = {};
|
|
137
|
+
if (requestParameters['sectionId'] != null) {
|
|
138
|
+
queryParameters['section_id'] = requestParameters['sectionId'];
|
|
139
|
+
}
|
|
140
|
+
if (requestParameters['limit'] != null) {
|
|
141
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
142
|
+
}
|
|
143
|
+
if (requestParameters['offset'] != null) {
|
|
144
|
+
queryParameters['offset'] = requestParameters['offset'];
|
|
145
|
+
}
|
|
146
|
+
const headerParameters = {};
|
|
147
|
+
let urlPath = `/v1/document_versions/{version_id}/contents`;
|
|
148
|
+
urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
|
|
149
|
+
const response = yield this.request({
|
|
150
|
+
path: urlPath,
|
|
151
|
+
method: 'GET',
|
|
152
|
+
headers: headerParameters,
|
|
153
|
+
query: queryParameters,
|
|
154
|
+
}, initOverrides);
|
|
155
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseDocumentContentPathPartFromJSON)(jsonValue));
|
|
156
|
+
});
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
|
|
160
|
+
* Get Document Version Contents Handler
|
|
161
|
+
*/
|
|
162
|
+
getDocumentVersionContents(requestParameters, initOverrides) {
|
|
163
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
164
|
+
const response = yield this.getDocumentVersionContentsRaw(requestParameters, initOverrides);
|
|
165
|
+
return yield response.value();
|
|
166
|
+
});
|
|
167
|
+
}
|
|
127
168
|
/**
|
|
128
169
|
* List all versions for a document. Returns versions ordered by version number ascending (v0, v1, v2...).
|
|
129
170
|
* List Document Versions Handler
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CreateFolderRequest, FolderResponse, PaginatedResponseFolderResponse, PathOrder, UpdateFolderRequest } from '../models/index';
|
|
13
|
+
import type { CreateFolderRequest, FolderResponse, PaginatedResponseFolderDocumentResponse, PaginatedResponseFolderResponse, PathOrder, UpdateFolderRequest } from '../models/index';
|
|
14
14
|
export interface CreateFolderOperationRequest {
|
|
15
15
|
createFolderRequest: CreateFolderRequest;
|
|
16
16
|
ksUat?: string;
|
|
@@ -23,6 +23,14 @@ export interface GetFolderRequest {
|
|
|
23
23
|
folderId: string;
|
|
24
24
|
ksUat?: string;
|
|
25
25
|
}
|
|
26
|
+
export interface ListFolderContentsRequest {
|
|
27
|
+
folderId: string;
|
|
28
|
+
maxDepth?: number;
|
|
29
|
+
sortOrder?: PathOrder;
|
|
30
|
+
limit?: number;
|
|
31
|
+
offset?: number;
|
|
32
|
+
ksUat?: string;
|
|
33
|
+
}
|
|
26
34
|
export interface ListFoldersRequest {
|
|
27
35
|
parentId?: string;
|
|
28
36
|
sortOrder?: PathOrder;
|
|
@@ -87,6 +95,25 @@ export interface FoldersApiInterface {
|
|
|
87
95
|
* Get Folder Handler
|
|
88
96
|
*/
|
|
89
97
|
getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
|
|
98
|
+
/**
|
|
99
|
+
* 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.
|
|
100
|
+
* @summary List Folder Contents Handler
|
|
101
|
+
* @param {string} folderId
|
|
102
|
+
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
103
|
+
* @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
104
|
+
* @param {number} [limit] Number of items per page
|
|
105
|
+
* @param {number} [offset] Number of items to skip
|
|
106
|
+
* @param {string} [ksUat]
|
|
107
|
+
* @param {*} [options] Override http request option.
|
|
108
|
+
* @throws {RequiredError}
|
|
109
|
+
* @memberof FoldersApiInterface
|
|
110
|
+
*/
|
|
111
|
+
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderDocumentResponse>>;
|
|
112
|
+
/**
|
|
113
|
+
* 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.
|
|
114
|
+
* List Folder Contents Handler
|
|
115
|
+
*/
|
|
116
|
+
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
|
|
90
117
|
/**
|
|
91
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.
|
|
92
119
|
* @summary List Folders Handler
|
|
@@ -156,6 +183,16 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
|
|
|
156
183
|
* Get Folder Handler
|
|
157
184
|
*/
|
|
158
185
|
getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
|
|
186
|
+
/**
|
|
187
|
+
* 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.
|
|
188
|
+
* List Folder Contents Handler
|
|
189
|
+
*/
|
|
190
|
+
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderDocumentResponse>>;
|
|
191
|
+
/**
|
|
192
|
+
* 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.
|
|
193
|
+
* List Folder Contents Handler
|
|
194
|
+
*/
|
|
195
|
+
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
|
|
159
196
|
/**
|
|
160
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.
|
|
161
198
|
* List Folders Handler
|
package/dist/apis/FoldersApi.js
CHANGED
|
@@ -125,6 +125,50 @@ class FoldersApi extends runtime.BaseAPI {
|
|
|
125
125
|
return yield response.value();
|
|
126
126
|
});
|
|
127
127
|
}
|
|
128
|
+
/**
|
|
129
|
+
* 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.
|
|
130
|
+
* List Folder Contents Handler
|
|
131
|
+
*/
|
|
132
|
+
listFolderContentsRaw(requestParameters, initOverrides) {
|
|
133
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
134
|
+
if (requestParameters['folderId'] == null) {
|
|
135
|
+
throw new runtime.RequiredError('folderId', 'Required parameter "folderId" was null or undefined when calling listFolderContents().');
|
|
136
|
+
}
|
|
137
|
+
const queryParameters = {};
|
|
138
|
+
if (requestParameters['maxDepth'] != null) {
|
|
139
|
+
queryParameters['max_depth'] = requestParameters['maxDepth'];
|
|
140
|
+
}
|
|
141
|
+
if (requestParameters['sortOrder'] != null) {
|
|
142
|
+
queryParameters['sort_order'] = requestParameters['sortOrder'];
|
|
143
|
+
}
|
|
144
|
+
if (requestParameters['limit'] != null) {
|
|
145
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
146
|
+
}
|
|
147
|
+
if (requestParameters['offset'] != null) {
|
|
148
|
+
queryParameters['offset'] = requestParameters['offset'];
|
|
149
|
+
}
|
|
150
|
+
const headerParameters = {};
|
|
151
|
+
let urlPath = `/v1/folders/{folder_id}/contents`;
|
|
152
|
+
urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
|
|
153
|
+
const response = yield this.request({
|
|
154
|
+
path: urlPath,
|
|
155
|
+
method: 'GET',
|
|
156
|
+
headers: headerParameters,
|
|
157
|
+
query: queryParameters,
|
|
158
|
+
}, initOverrides);
|
|
159
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseFolderDocumentResponseFromJSON)(jsonValue));
|
|
160
|
+
});
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* 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.
|
|
164
|
+
* List Folder Contents Handler
|
|
165
|
+
*/
|
|
166
|
+
listFolderContents(requestParameters, initOverrides) {
|
|
167
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
168
|
+
const response = yield this.listFolderContentsRaw(requestParameters, initOverrides);
|
|
169
|
+
return yield response.value();
|
|
170
|
+
});
|
|
171
|
+
}
|
|
128
172
|
/**
|
|
129
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.
|
|
130
174
|
* List Folders Handler
|
|
@@ -17,7 +17,6 @@ export interface GetPathPartRequest {
|
|
|
17
17
|
}
|
|
18
18
|
export interface ListPathPartsRequest {
|
|
19
19
|
parentId?: string;
|
|
20
|
-
includeDocuments?: boolean;
|
|
21
20
|
maxDepth?: number;
|
|
22
21
|
sortOrder?: PathOrder;
|
|
23
22
|
limit?: number;
|
|
@@ -47,10 +46,9 @@ export interface PathPartsApiInterface {
|
|
|
47
46
|
*/
|
|
48
47
|
getPathPart(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse>;
|
|
49
48
|
/**
|
|
50
|
-
* List path parts under a parent with
|
|
49
|
+
* List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
|
|
51
50
|
* @summary List Path Parts Handler
|
|
52
51
|
* @param {string} [parentId] Parent PathPart ID (defaults to root)
|
|
53
|
-
* @param {boolean} [includeDocuments] Include documents in results (default: False, folders only)
|
|
54
52
|
* @param {number} [maxDepth] Maximum depth to traverse (1 = direct children, default: 1)
|
|
55
53
|
* @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
56
54
|
* @param {number} [limit] Number of items per page
|
|
@@ -62,7 +60,7 @@ export interface PathPartsApiInterface {
|
|
|
62
60
|
*/
|
|
63
61
|
listPathPartsRaw(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePathPartResponse>>;
|
|
64
62
|
/**
|
|
65
|
-
* List path parts under a parent with
|
|
63
|
+
* List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
|
|
66
64
|
* List Path Parts Handler
|
|
67
65
|
*/
|
|
68
66
|
listPathParts(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponsePathPartResponse>;
|
|
@@ -82,12 +80,12 @@ export declare class PathPartsApi extends runtime.BaseAPI implements PathPartsAp
|
|
|
82
80
|
*/
|
|
83
81
|
getPathPart(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse>;
|
|
84
82
|
/**
|
|
85
|
-
* List path parts under a parent with
|
|
83
|
+
* List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
|
|
86
84
|
* List Path Parts Handler
|
|
87
85
|
*/
|
|
88
86
|
listPathPartsRaw(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePathPartResponse>>;
|
|
89
87
|
/**
|
|
90
|
-
* List path parts under a parent with
|
|
88
|
+
* List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
|
|
91
89
|
* List Path Parts Handler
|
|
92
90
|
*/
|
|
93
91
|
listPathParts(requestParameters?: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponsePathPartResponse>;
|
|
@@ -62,7 +62,7 @@ class PathPartsApi extends runtime.BaseAPI {
|
|
|
62
62
|
});
|
|
63
63
|
}
|
|
64
64
|
/**
|
|
65
|
-
* List path parts under a parent with
|
|
65
|
+
* List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
|
|
66
66
|
* List Path Parts Handler
|
|
67
67
|
*/
|
|
68
68
|
listPathPartsRaw(requestParameters, initOverrides) {
|
|
@@ -71,9 +71,6 @@ class PathPartsApi extends runtime.BaseAPI {
|
|
|
71
71
|
if (requestParameters['parentId'] != null) {
|
|
72
72
|
queryParameters['parent_id'] = requestParameters['parentId'];
|
|
73
73
|
}
|
|
74
|
-
if (requestParameters['includeDocuments'] != null) {
|
|
75
|
-
queryParameters['include_documents'] = requestParameters['includeDocuments'];
|
|
76
|
-
}
|
|
77
74
|
if (requestParameters['maxDepth'] != null) {
|
|
78
75
|
queryParameters['max_depth'] = requestParameters['maxDepth'];
|
|
79
76
|
}
|
|
@@ -98,7 +95,7 @@ class PathPartsApi extends runtime.BaseAPI {
|
|
|
98
95
|
});
|
|
99
96
|
}
|
|
100
97
|
/**
|
|
101
|
-
* List path parts under a parent with
|
|
98
|
+
* List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
|
|
102
99
|
* List Path Parts Handler
|
|
103
100
|
*/
|
|
104
101
|
listPathParts() {
|
|
@@ -0,0 +1,123 @@
|
|
|
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 { CreateThreadMessageRequest, PaginatedResponseThreadMessageResponse, ThreadMessageResponse } from '../models/index';
|
|
14
|
+
export interface CreateThreadMessageOperationRequest {
|
|
15
|
+
threadId: string;
|
|
16
|
+
createThreadMessageRequest: CreateThreadMessageRequest;
|
|
17
|
+
ksUat?: string;
|
|
18
|
+
}
|
|
19
|
+
export interface GetThreadMessageRequest {
|
|
20
|
+
threadId: string;
|
|
21
|
+
messageId: string;
|
|
22
|
+
ksUat?: string;
|
|
23
|
+
}
|
|
24
|
+
export interface ListThreadMessagesRequest {
|
|
25
|
+
threadId: string;
|
|
26
|
+
before?: Date;
|
|
27
|
+
limit?: number;
|
|
28
|
+
offset?: number;
|
|
29
|
+
ksUat?: string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* ThreadMessagesApi - interface
|
|
33
|
+
*
|
|
34
|
+
* @export
|
|
35
|
+
* @interface ThreadMessagesApiInterface
|
|
36
|
+
*/
|
|
37
|
+
export interface ThreadMessagesApiInterface {
|
|
38
|
+
/**
|
|
39
|
+
* Create a new message in a thread.
|
|
40
|
+
* @summary Create Thread Message Handler
|
|
41
|
+
* @param {string} threadId
|
|
42
|
+
* @param {CreateThreadMessageRequest} createThreadMessageRequest
|
|
43
|
+
* @param {string} [ksUat]
|
|
44
|
+
* @param {*} [options] Override http request option.
|
|
45
|
+
* @throws {RequiredError}
|
|
46
|
+
* @memberof ThreadMessagesApiInterface
|
|
47
|
+
*/
|
|
48
|
+
createThreadMessageRaw(requestParameters: CreateThreadMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadMessageResponse>>;
|
|
49
|
+
/**
|
|
50
|
+
* Create a new message in a thread.
|
|
51
|
+
* Create Thread Message Handler
|
|
52
|
+
*/
|
|
53
|
+
createThreadMessage(requestParameters: CreateThreadMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadMessageResponse>;
|
|
54
|
+
/**
|
|
55
|
+
* Get a specific message by its ID.
|
|
56
|
+
* @summary Get Thread Message Handler
|
|
57
|
+
* @param {string} threadId
|
|
58
|
+
* @param {string} messageId
|
|
59
|
+
* @param {string} [ksUat]
|
|
60
|
+
* @param {*} [options] Override http request option.
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
* @memberof ThreadMessagesApiInterface
|
|
63
|
+
*/
|
|
64
|
+
getThreadMessageRaw(requestParameters: GetThreadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadMessageResponse>>;
|
|
65
|
+
/**
|
|
66
|
+
* Get a specific message by its ID.
|
|
67
|
+
* Get Thread Message Handler
|
|
68
|
+
*/
|
|
69
|
+
getThreadMessage(requestParameters: GetThreadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadMessageResponse>;
|
|
70
|
+
/**
|
|
71
|
+
* List messages in a thread, ordered by created_at descending. Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.
|
|
72
|
+
* @summary List Thread Messages Handler
|
|
73
|
+
* @param {string} threadId
|
|
74
|
+
* @param {Date} [before] Cursor for keyset pagination: only return messages with created_at < this value
|
|
75
|
+
* @param {number} [limit] Number of items per page
|
|
76
|
+
* @param {number} [offset] Number of items to skip
|
|
77
|
+
* @param {string} [ksUat]
|
|
78
|
+
* @param {*} [options] Override http request option.
|
|
79
|
+
* @throws {RequiredError}
|
|
80
|
+
* @memberof ThreadMessagesApiInterface
|
|
81
|
+
*/
|
|
82
|
+
listThreadMessagesRaw(requestParameters: ListThreadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseThreadMessageResponse>>;
|
|
83
|
+
/**
|
|
84
|
+
* List messages in a thread, ordered by created_at descending. Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.
|
|
85
|
+
* List Thread Messages Handler
|
|
86
|
+
*/
|
|
87
|
+
listThreadMessages(requestParameters: ListThreadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseThreadMessageResponse>;
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
*
|
|
91
|
+
*/
|
|
92
|
+
export declare class ThreadMessagesApi extends runtime.BaseAPI implements ThreadMessagesApiInterface {
|
|
93
|
+
/**
|
|
94
|
+
* Create a new message in a thread.
|
|
95
|
+
* Create Thread Message Handler
|
|
96
|
+
*/
|
|
97
|
+
createThreadMessageRaw(requestParameters: CreateThreadMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadMessageResponse>>;
|
|
98
|
+
/**
|
|
99
|
+
* Create a new message in a thread.
|
|
100
|
+
* Create Thread Message Handler
|
|
101
|
+
*/
|
|
102
|
+
createThreadMessage(requestParameters: CreateThreadMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadMessageResponse>;
|
|
103
|
+
/**
|
|
104
|
+
* Get a specific message by its ID.
|
|
105
|
+
* Get Thread Message Handler
|
|
106
|
+
*/
|
|
107
|
+
getThreadMessageRaw(requestParameters: GetThreadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadMessageResponse>>;
|
|
108
|
+
/**
|
|
109
|
+
* Get a specific message by its ID.
|
|
110
|
+
* Get Thread Message Handler
|
|
111
|
+
*/
|
|
112
|
+
getThreadMessage(requestParameters: GetThreadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadMessageResponse>;
|
|
113
|
+
/**
|
|
114
|
+
* List messages in a thread, ordered by created_at descending. Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.
|
|
115
|
+
* List Thread Messages Handler
|
|
116
|
+
*/
|
|
117
|
+
listThreadMessagesRaw(requestParameters: ListThreadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseThreadMessageResponse>>;
|
|
118
|
+
/**
|
|
119
|
+
* List messages in a thread, ordered by created_at descending. Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.
|
|
120
|
+
* List Thread Messages Handler
|
|
121
|
+
*/
|
|
122
|
+
listThreadMessages(requestParameters: ListThreadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseThreadMessageResponse>;
|
|
123
|
+
}
|