@knowledge-stack/ksapi 1.23.4 → 1.24.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 +125 -6
- package/.openapi-generator/VERSION +1 -1
- package/README.md +274 -28
- package/dist/apis/AuthApi.d.ts +117 -0
- package/dist/apis/AuthApi.js +137 -47
- package/dist/apis/ChunkLineagesApi.d.ts +38 -0
- package/dist/apis/ChunkLineagesApi.js +42 -15
- package/dist/apis/ChunksApi.d.ts +78 -4
- package/dist/apis/ChunksApi.js +85 -31
- package/dist/apis/DefaultApi.d.ts +20 -0
- package/dist/apis/DefaultApi.js +28 -10
- package/dist/apis/DocumentVersionsApi.d.ts +99 -9
- package/dist/apis/DocumentVersionsApi.js +100 -37
- package/dist/apis/DocumentsApi.d.ts +80 -0
- package/dist/apis/DocumentsApi.js +84 -30
- package/dist/apis/FoldersApi.d.ts +92 -9
- package/dist/apis/FoldersApi.js +86 -32
- package/dist/apis/InvitesApi.d.ts +51 -0
- package/dist/apis/InvitesApi.js +56 -20
- package/dist/apis/PathPartsApi.d.ts +54 -0
- package/dist/apis/PathPartsApi.js +56 -20
- package/dist/apis/SectionsApi.d.ts +49 -0
- package/dist/apis/SectionsApi.js +56 -20
- package/dist/apis/TagsApi.d.ts +62 -0
- package/dist/apis/TagsApi.js +70 -25
- package/dist/apis/TenantsApi.d.ts +172 -5
- package/dist/apis/TenantsApi.js +179 -31
- package/dist/apis/ThreadMessagesApi.d.ts +41 -0
- package/dist/apis/ThreadMessagesApi.js +42 -15
- package/dist/apis/ThreadsApi.d.ts +77 -0
- package/dist/apis/ThreadsApi.js +84 -30
- package/dist/apis/UserPermissionsApi.d.ts +54 -0
- package/dist/apis/UserPermissionsApi.js +56 -20
- package/dist/apis/UsersApi.d.ts +23 -0
- package/dist/apis/UsersApi.js +28 -10
- package/dist/apis/WorkflowsApi.d.ts +38 -0
- package/dist/apis/WorkflowsApi.js +42 -15
- package/dist/esm/apis/AuthApi.d.ts +117 -0
- package/dist/esm/apis/AuthApi.js +137 -47
- package/dist/esm/apis/ChunkLineagesApi.d.ts +38 -0
- package/dist/esm/apis/ChunkLineagesApi.js +42 -15
- package/dist/esm/apis/ChunksApi.d.ts +78 -4
- package/dist/esm/apis/ChunksApi.js +85 -31
- package/dist/esm/apis/DefaultApi.d.ts +20 -0
- package/dist/esm/apis/DefaultApi.js +28 -10
- package/dist/esm/apis/DocumentVersionsApi.d.ts +99 -9
- package/dist/esm/apis/DocumentVersionsApi.js +101 -38
- package/dist/esm/apis/DocumentsApi.d.ts +80 -0
- package/dist/esm/apis/DocumentsApi.js +84 -30
- package/dist/esm/apis/FoldersApi.d.ts +92 -9
- package/dist/esm/apis/FoldersApi.js +87 -33
- package/dist/esm/apis/InvitesApi.d.ts +51 -0
- package/dist/esm/apis/InvitesApi.js +56 -20
- package/dist/esm/apis/PathPartsApi.d.ts +54 -0
- package/dist/esm/apis/PathPartsApi.js +56 -20
- package/dist/esm/apis/SectionsApi.d.ts +49 -0
- package/dist/esm/apis/SectionsApi.js +56 -20
- package/dist/esm/apis/TagsApi.d.ts +62 -0
- package/dist/esm/apis/TagsApi.js +70 -25
- package/dist/esm/apis/TenantsApi.d.ts +172 -5
- package/dist/esm/apis/TenantsApi.js +180 -32
- package/dist/esm/apis/ThreadMessagesApi.d.ts +41 -0
- package/dist/esm/apis/ThreadMessagesApi.js +42 -15
- package/dist/esm/apis/ThreadsApi.d.ts +77 -0
- package/dist/esm/apis/ThreadsApi.js +84 -30
- package/dist/esm/apis/UserPermissionsApi.d.ts +54 -0
- package/dist/esm/apis/UserPermissionsApi.js +56 -20
- package/dist/esm/apis/UsersApi.d.ts +23 -0
- package/dist/esm/apis/UsersApi.js +28 -10
- package/dist/esm/apis/WorkflowsApi.d.ts +38 -0
- package/dist/esm/apis/WorkflowsApi.js +42 -15
- package/dist/esm/models/{DocumentContentPathPart.d.ts → ChunkContentItem.d.ts} +37 -40
- package/dist/esm/models/{DocumentContentPathPart.js → ChunkContentItem.js} +17 -16
- package/dist/esm/models/ChunkResponse.d.ts +6 -0
- package/dist/esm/models/ChunkResponse.js +2 -0
- package/dist/esm/models/DocumentResponse.d.ts +13 -0
- package/dist/esm/models/DocumentResponse.js +8 -0
- package/dist/esm/models/FolderResponse.d.ts +13 -0
- package/dist/esm/models/FolderResponse.js +8 -0
- package/dist/esm/models/FolderResponseOrDocumentResponse.d.ts +27 -0
- package/dist/esm/models/FolderResponseOrDocumentResponse.js +47 -0
- package/dist/esm/models/InviteResponse.d.ts +7 -0
- package/dist/esm/models/InviteResponse.js +5 -0
- package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.js +70 -0
- package/dist/esm/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.js +70 -0
- package/dist/esm/models/PaginatedResponseTenantUserResponse.d.ts +66 -0
- package/dist/esm/models/{PaginatedResponseTenantUserInTenantResponse.js → PaginatedResponseTenantUserResponse.js} +12 -12
- package/dist/esm/models/ScoredChunkResponse.d.ts +6 -0
- package/dist/esm/models/ScoredChunkResponse.js +2 -0
- package/dist/esm/models/SectionContentItem.d.ts +114 -0
- package/dist/esm/models/SectionContentItem.js +86 -0
- package/dist/esm/models/SectionContentItemOrChunkContentItem.d.ts +27 -0
- package/dist/esm/models/SectionContentItemOrChunkContentItem.js +47 -0
- package/dist/esm/models/TenantUserEditRequest.d.ts +48 -0
- package/dist/esm/models/TenantUserEditRequest.js +45 -0
- package/dist/esm/models/{TenantUserInTenantResponse.d.ts → TenantUserResponse.d.ts} +19 -13
- package/dist/esm/models/{TenantUserInTenantResponse.js → TenantUserResponse.js} +13 -9
- package/dist/esm/models/index.d.ts +9 -6
- package/dist/esm/models/index.js +9 -6
- package/dist/models/{DocumentContentPathPart.d.ts → ChunkContentItem.d.ts} +37 -40
- package/dist/models/{DocumentContentPathPart.js → ChunkContentItem.js} +23 -22
- package/dist/models/ChunkResponse.d.ts +6 -0
- package/dist/models/ChunkResponse.js +2 -0
- package/dist/models/DocumentResponse.d.ts +13 -0
- package/dist/models/DocumentResponse.js +9 -1
- package/dist/models/FolderResponse.d.ts +13 -0
- package/dist/models/FolderResponse.js +9 -1
- package/dist/models/FolderResponseOrDocumentResponse.d.ts +27 -0
- package/dist/models/FolderResponseOrDocumentResponse.js +53 -0
- package/dist/models/InviteResponse.d.ts +7 -0
- package/dist/models/InviteResponse.js +5 -0
- package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.d.ts +66 -0
- package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.js +78 -0
- package/dist/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.d.ts +66 -0
- package/dist/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.js +78 -0
- package/dist/models/PaginatedResponseTenantUserResponse.d.ts +66 -0
- package/dist/models/PaginatedResponseTenantUserResponse.js +78 -0
- package/dist/models/ScoredChunkResponse.d.ts +6 -0
- package/dist/models/ScoredChunkResponse.js +2 -0
- package/dist/models/SectionContentItem.d.ts +114 -0
- package/dist/models/SectionContentItem.js +94 -0
- package/dist/models/SectionContentItemOrChunkContentItem.d.ts +27 -0
- package/dist/models/SectionContentItemOrChunkContentItem.js +53 -0
- package/dist/models/TenantUserEditRequest.d.ts +48 -0
- package/dist/models/TenantUserEditRequest.js +53 -0
- package/dist/models/{TenantUserInTenantResponse.d.ts → TenantUserResponse.d.ts} +19 -13
- package/dist/models/{TenantUserInTenantResponse.js → TenantUserResponse.js} +19 -15
- package/dist/models/index.d.ts +9 -6
- package/dist/models/index.js +9 -6
- package/docs/AuthApi.md +707 -0
- package/docs/BulkTagRequest.md +35 -0
- package/docs/ChunkContentItem.md +59 -0
- package/docs/ChunkLineageResponse.md +41 -0
- package/docs/ChunkLineagesApi.md +230 -0
- package/docs/ChunkMetadataInput.md +37 -0
- package/docs/ChunkMetadataOutput.md +37 -0
- package/docs/ChunkResponse.md +63 -0
- package/docs/ChunkSearchRequest.md +47 -0
- package/docs/ChunkType.md +33 -0
- package/docs/ChunksApi.md +446 -0
- package/docs/ClearVersionContentsResponse.md +35 -0
- package/docs/CreateChunkLineageRequest.md +37 -0
- package/docs/CreateChunkRequest.md +43 -0
- package/docs/CreateDocumentRequest.md +41 -0
- package/docs/CreateFolderRequest.md +37 -0
- package/docs/CreatePasswordUserRequest.md +36 -0
- package/docs/CreatePermissionRequest.md +40 -0
- package/docs/CreateSectionRequest.md +41 -0
- package/docs/CreateTagRequest.md +39 -0
- package/docs/CreateTenantRequest.md +37 -0
- package/docs/CreateThreadMessageRequest.md +37 -0
- package/docs/CreateThreadRequest.md +37 -0
- package/docs/DefaultApi.md +128 -0
- package/docs/DocumentOrigin.md +33 -0
- package/docs/DocumentResponse.md +63 -0
- package/docs/DocumentType.md +33 -0
- package/docs/DocumentVersionMetadata.md +47 -0
- package/docs/DocumentVersionMetadataUpdate.md +47 -0
- package/docs/DocumentVersionResponse.md +57 -0
- package/docs/DocumentVersionsApi.md +530 -0
- package/docs/DocumentsApi.md +464 -0
- package/docs/EmailSentResponse.md +34 -0
- package/docs/EmailVerificationRequest.md +34 -0
- package/docs/EmbeddingModel.md +33 -0
- package/docs/FolderResponse.md +55 -0
- package/docs/FolderResponseOrDocumentResponse.md +62 -0
- package/docs/FoldersApi.md +473 -0
- package/docs/HTTPValidationError.md +34 -0
- package/docs/HealthCheckResponse.md +36 -0
- package/docs/IdpType.md +33 -0
- package/docs/IngestDocumentResponse.md +39 -0
- package/docs/InviteResponse.md +53 -0
- package/docs/InviteStatus.md +32 -0
- package/docs/InviteUserRequest.md +38 -0
- package/docs/InvitesApi.md +305 -0
- package/docs/LineageEdgeResponse.md +37 -0
- package/docs/LineageGraphResponse.md +37 -0
- package/docs/LineageNodeResponse.md +47 -0
- package/docs/LocationInner.md +32 -0
- package/docs/MessageRole.md +33 -0
- package/docs/OAuth2Config.md +41 -0
- package/docs/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.md +40 -0
- package/docs/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.md +40 -0
- package/docs/PaginatedResponseDocumentResponse.md +40 -0
- package/docs/PaginatedResponseDocumentVersionResponse.md +40 -0
- package/docs/PaginatedResponseFolderResponse.md +40 -0
- package/docs/PaginatedResponseInviteResponse.md +40 -0
- package/docs/PaginatedResponsePathPartResponse.md +40 -0
- package/docs/PaginatedResponsePermissionResponse.md +40 -0
- package/docs/PaginatedResponseTagResponse.md +40 -0
- package/docs/PaginatedResponseTenantResponse.md +40 -0
- package/docs/PaginatedResponseTenantUserResponse.md +40 -0
- package/docs/PaginatedResponseThreadMessageResponse.md +40 -0
- package/docs/PaginatedResponseThreadResponse.md +40 -0
- package/docs/PaginatedResponseWorkflowSummaryResponse.md +40 -0
- package/docs/PartType.md +33 -0
- package/docs/PasswordResetRequest.md +36 -0
- package/docs/PasswordResetWithTokenRequest.md +36 -0
- package/docs/PathOrder.md +33 -0
- package/docs/PathPartResponse.md +53 -0
- package/docs/PathPartTagsResponse.md +35 -0
- package/docs/PathPartsApi.md +314 -0
- package/docs/PermissionCapability.md +33 -0
- package/docs/PermissionResponse.md +48 -0
- package/docs/PipelineState.md +45 -0
- package/docs/PipelineStatus.md +33 -0
- package/docs/Polygon.md +41 -0
- package/docs/PolygonReference.md +37 -0
- package/docs/RootResponse.md +36 -0
- package/docs/ScoredChunkResponse.md +65 -0
- package/docs/SectionContentItem.md +55 -0
- package/docs/SectionContentItemOrChunkContentItem.md +60 -0
- package/docs/SectionResponse.md +57 -0
- package/docs/SectionsApi.md +299 -0
- package/docs/SignInRequest.md +38 -0
- package/docs/TagResponse.md +47 -0
- package/docs/TagsApi.md +374 -0
- package/docs/TenantResponse.md +39 -0
- package/docs/TenantUserEditRequest.md +35 -0
- package/docs/TenantUserResponse.md +43 -0
- package/docs/TenantUserRole.md +33 -0
- package/docs/TenantsApi.md +605 -0
- package/docs/ThreadMessageResponse.md +53 -0
- package/docs/ThreadMessagesApi.md +239 -0
- package/docs/ThreadResponse.md +49 -0
- package/docs/ThreadsApi.md +455 -0
- package/docs/UpdateChunkContentRequest.md +37 -0
- package/docs/UpdateChunkMetadataRequest.md +35 -0
- package/docs/UpdateDocumentRequest.md +39 -0
- package/docs/UpdateFolderRequest.md +37 -0
- package/docs/UpdatePermissionRequest.md +36 -0
- package/docs/UpdateSectionRequest.md +41 -0
- package/docs/UpdateTagRequest.md +39 -0
- package/docs/UpdateTenantRequest.md +37 -0
- package/docs/UpdateThreadRequest.md +37 -0
- package/docs/UpdateUserRequest.md +34 -0
- package/docs/UserPermissionsApi.md +314 -0
- package/docs/UserResponse.md +44 -0
- package/docs/UsersApi.md +149 -0
- package/docs/ValidationError.md +42 -0
- package/docs/WorkflowAction.md +33 -0
- package/docs/WorkflowActionResponse.md +39 -0
- package/docs/WorkflowDetailResponse.md +63 -0
- package/docs/WorkflowSummaryResponse.md +49 -0
- package/docs/WorkflowsApi.md +230 -0
- package/package.json +1 -1
- package/src/apis/AuthApi.ts +214 -47
- package/src/apis/ChunkLineagesApi.ts +68 -15
- package/src/apis/ChunksApi.ts +137 -33
- package/src/apis/DefaultApi.ts +40 -10
- package/src/apis/DocumentVersionsApi.ts +170 -45
- package/src/apis/DocumentsApi.ts +140 -30
- package/src/apis/FoldersApi.ts +153 -40
- package/src/apis/InvitesApi.ts +91 -20
- package/src/apis/PathPartsApi.ts +94 -20
- package/src/apis/SectionsApi.ts +89 -20
- package/src/apis/TagsApi.ts +112 -25
- package/src/apis/TenantsApi.ts +339 -37
- package/src/apis/ThreadMessagesApi.ts +71 -15
- package/src/apis/ThreadsApi.ts +137 -30
- package/src/apis/UserPermissionsApi.ts +94 -20
- package/src/apis/UsersApi.ts +43 -10
- package/src/apis/WorkflowsApi.ts +68 -15
- package/src/models/{DocumentContentPathPart.ts → ChunkContentItem.ts} +42 -53
- package/src/models/ChunkResponse.ts +8 -0
- package/src/models/DocumentResponse.ts +16 -0
- package/src/models/FolderResponse.ts +18 -0
- package/src/models/FolderResponseOrDocumentResponse.ts +72 -0
- package/src/models/InviteResponse.ts +19 -0
- package/src/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.ts +130 -0
- package/src/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.ts +130 -0
- package/src/models/{PaginatedResponseFolderDocumentResponse.ts → PaginatedResponseTenantUserResponse.ts} +25 -25
- package/src/models/ScoredChunkResponse.ts +8 -0
- package/src/models/SectionContentItem.ts +181 -0
- package/src/models/SectionContentItemOrChunkContentItem.ts +72 -0
- package/src/models/TenantUserEditRequest.ts +93 -0
- package/src/models/{TenantUserInTenantResponse.ts → TenantUserResponse.ts} +24 -15
- package/src/models/index.ts +9 -6
- package/dist/esm/models/FolderDocumentResponse.d.ts +0 -157
- package/dist/esm/models/FolderDocumentResponse.js +0 -99
- package/dist/esm/models/PaginatedResponseDocumentContentPathPart.d.ts +0 -66
- package/dist/esm/models/PaginatedResponseDocumentContentPathPart.js +0 -70
- package/dist/esm/models/PaginatedResponseFolderDocumentResponse.d.ts +0 -66
- package/dist/esm/models/PaginatedResponseFolderDocumentResponse.js +0 -70
- package/dist/esm/models/PaginatedResponseTenantUserInTenantResponse.d.ts +0 -66
- package/dist/models/FolderDocumentResponse.d.ts +0 -157
- package/dist/models/FolderDocumentResponse.js +0 -107
- package/dist/models/PaginatedResponseDocumentContentPathPart.d.ts +0 -66
- package/dist/models/PaginatedResponseDocumentContentPathPart.js +0 -78
- package/dist/models/PaginatedResponseFolderDocumentResponse.d.ts +0 -66
- package/dist/models/PaginatedResponseFolderDocumentResponse.js +0 -78
- package/dist/models/PaginatedResponseTenantUserInTenantResponse.d.ts +0 -66
- package/dist/models/PaginatedResponseTenantUserInTenantResponse.js +0 -78
- package/src/models/FolderDocumentResponse.ts +0 -267
- package/src/models/PaginatedResponseDocumentContentPathPart.ts +0 -130
- package/src/models/PaginatedResponseTenantUserInTenantResponse.ts +0 -130
|
@@ -50,6 +50,14 @@ export interface UpdateDocumentOperationRequest {
|
|
|
50
50
|
* @interface DocumentsApiInterface
|
|
51
51
|
*/
|
|
52
52
|
export interface DocumentsApiInterface {
|
|
53
|
+
/**
|
|
54
|
+
* Creates request options for createDocument without sending the request
|
|
55
|
+
* @param {CreateDocumentRequest} createDocumentRequest
|
|
56
|
+
* @param {string} [ksUat]
|
|
57
|
+
* @throws {RequiredError}
|
|
58
|
+
* @memberof DocumentsApiInterface
|
|
59
|
+
*/
|
|
60
|
+
createDocumentRequestOpts(requestParameters: CreateDocumentOperationRequest): Promise<runtime.RequestOpts>;
|
|
53
61
|
/**
|
|
54
62
|
* Create a new document with initial v0 version. The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
|
|
55
63
|
* @summary Create Document Handler
|
|
@@ -65,6 +73,14 @@ export interface DocumentsApiInterface {
|
|
|
65
73
|
* Create Document Handler
|
|
66
74
|
*/
|
|
67
75
|
createDocument(requestParameters: CreateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
|
|
76
|
+
/**
|
|
77
|
+
* Creates request options for deleteDocument without sending the request
|
|
78
|
+
* @param {string} documentId
|
|
79
|
+
* @param {string} [ksUat]
|
|
80
|
+
* @throws {RequiredError}
|
|
81
|
+
* @memberof DocumentsApiInterface
|
|
82
|
+
*/
|
|
83
|
+
deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts>;
|
|
68
84
|
/**
|
|
69
85
|
* Delete a document and all its contents. WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
|
|
70
86
|
* @summary Delete Document Handler
|
|
@@ -80,6 +96,15 @@ export interface DocumentsApiInterface {
|
|
|
80
96
|
* Delete Document Handler
|
|
81
97
|
*/
|
|
82
98
|
deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
99
|
+
/**
|
|
100
|
+
* Creates request options for getDocument without sending the request
|
|
101
|
+
* @param {string} documentId
|
|
102
|
+
* @param {boolean} [withTags] Include tags in the response (default: false)
|
|
103
|
+
* @param {string} [ksUat]
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
* @memberof DocumentsApiInterface
|
|
106
|
+
*/
|
|
107
|
+
getDocumentRequestOpts(requestParameters: GetDocumentRequest): Promise<runtime.RequestOpts>;
|
|
83
108
|
/**
|
|
84
109
|
* Get a document by its document ID.
|
|
85
110
|
* @summary Get Document Handler
|
|
@@ -96,6 +121,16 @@ export interface DocumentsApiInterface {
|
|
|
96
121
|
* Get Document Handler
|
|
97
122
|
*/
|
|
98
123
|
getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
|
|
124
|
+
/**
|
|
125
|
+
* Creates request options for ingestDocument without sending the request
|
|
126
|
+
* @param {Blob} file
|
|
127
|
+
* @param {string} pathPartId Parent path part ID (must be a FOLDER type)
|
|
128
|
+
* @param {string} [ksUat]
|
|
129
|
+
* @param {string} [name] Document name (defaults to filename)
|
|
130
|
+
* @throws {RequiredError}
|
|
131
|
+
* @memberof DocumentsApiInterface
|
|
132
|
+
*/
|
|
133
|
+
ingestDocumentRequestOpts(requestParameters: IngestDocumentRequest): Promise<runtime.RequestOpts>;
|
|
99
134
|
/**
|
|
100
135
|
* 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.
|
|
101
136
|
* @summary Ingest Document Handler
|
|
@@ -113,6 +148,18 @@ export interface DocumentsApiInterface {
|
|
|
113
148
|
* Ingest Document Handler
|
|
114
149
|
*/
|
|
115
150
|
ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
|
|
151
|
+
/**
|
|
152
|
+
* Creates request options for listDocuments without sending the request
|
|
153
|
+
* @param {string} [parentPathPartId] Parent PathPart ID (defaults to root)
|
|
154
|
+
* @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
155
|
+
* @param {boolean} [withTags] Include tags in the response (default: false)
|
|
156
|
+
* @param {number} [limit] Number of items per page
|
|
157
|
+
* @param {number} [offset] Number of items to skip
|
|
158
|
+
* @param {string} [ksUat]
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
* @memberof DocumentsApiInterface
|
|
161
|
+
*/
|
|
162
|
+
listDocumentsRequestOpts(requestParameters: ListDocumentsRequest): Promise<runtime.RequestOpts>;
|
|
116
163
|
/**
|
|
117
164
|
* List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
|
|
118
165
|
* @summary List Documents Handler
|
|
@@ -132,6 +179,15 @@ export interface DocumentsApiInterface {
|
|
|
132
179
|
* List Documents Handler
|
|
133
180
|
*/
|
|
134
181
|
listDocuments(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse>;
|
|
182
|
+
/**
|
|
183
|
+
* Creates request options for updateDocument without sending the request
|
|
184
|
+
* @param {string} documentId
|
|
185
|
+
* @param {UpdateDocumentRequest} updateDocumentRequest
|
|
186
|
+
* @param {string} [ksUat]
|
|
187
|
+
* @throws {RequiredError}
|
|
188
|
+
* @memberof DocumentsApiInterface
|
|
189
|
+
*/
|
|
190
|
+
updateDocumentRequestOpts(requestParameters: UpdateDocumentOperationRequest): Promise<runtime.RequestOpts>;
|
|
135
191
|
/**
|
|
136
192
|
* Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_path_part_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
|
|
137
193
|
* @summary Update Document Handler
|
|
@@ -153,6 +209,10 @@ export interface DocumentsApiInterface {
|
|
|
153
209
|
*
|
|
154
210
|
*/
|
|
155
211
|
export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterface {
|
|
212
|
+
/**
|
|
213
|
+
* Creates request options for createDocument without sending the request
|
|
214
|
+
*/
|
|
215
|
+
createDocumentRequestOpts(requestParameters: CreateDocumentOperationRequest): Promise<runtime.RequestOpts>;
|
|
156
216
|
/**
|
|
157
217
|
* Create a new document with initial v0 version. The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
|
|
158
218
|
* Create Document Handler
|
|
@@ -163,6 +223,10 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
|
|
|
163
223
|
* Create Document Handler
|
|
164
224
|
*/
|
|
165
225
|
createDocument(requestParameters: CreateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
|
|
226
|
+
/**
|
|
227
|
+
* Creates request options for deleteDocument without sending the request
|
|
228
|
+
*/
|
|
229
|
+
deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts>;
|
|
166
230
|
/**
|
|
167
231
|
* Delete a document and all its contents. WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
|
|
168
232
|
* Delete Document Handler
|
|
@@ -173,6 +237,10 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
|
|
|
173
237
|
* Delete Document Handler
|
|
174
238
|
*/
|
|
175
239
|
deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
240
|
+
/**
|
|
241
|
+
* Creates request options for getDocument without sending the request
|
|
242
|
+
*/
|
|
243
|
+
getDocumentRequestOpts(requestParameters: GetDocumentRequest): Promise<runtime.RequestOpts>;
|
|
176
244
|
/**
|
|
177
245
|
* Get a document by its document ID.
|
|
178
246
|
* Get Document Handler
|
|
@@ -183,6 +251,10 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
|
|
|
183
251
|
* Get Document Handler
|
|
184
252
|
*/
|
|
185
253
|
getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
|
|
254
|
+
/**
|
|
255
|
+
* Creates request options for ingestDocument without sending the request
|
|
256
|
+
*/
|
|
257
|
+
ingestDocumentRequestOpts(requestParameters: IngestDocumentRequest): Promise<runtime.RequestOpts>;
|
|
186
258
|
/**
|
|
187
259
|
* 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.
|
|
188
260
|
* Ingest Document Handler
|
|
@@ -193,6 +265,10 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
|
|
|
193
265
|
* Ingest Document Handler
|
|
194
266
|
*/
|
|
195
267
|
ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
|
|
268
|
+
/**
|
|
269
|
+
* Creates request options for listDocuments without sending the request
|
|
270
|
+
*/
|
|
271
|
+
listDocumentsRequestOpts(requestParameters: ListDocumentsRequest): Promise<runtime.RequestOpts>;
|
|
196
272
|
/**
|
|
197
273
|
* List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
|
|
198
274
|
* List Documents Handler
|
|
@@ -203,6 +279,10 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
|
|
|
203
279
|
* List Documents Handler
|
|
204
280
|
*/
|
|
205
281
|
listDocuments(requestParameters?: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse>;
|
|
282
|
+
/**
|
|
283
|
+
* Creates request options for updateDocument without sending the request
|
|
284
|
+
*/
|
|
285
|
+
updateDocumentRequestOpts(requestParameters: UpdateDocumentOperationRequest): Promise<runtime.RequestOpts>;
|
|
206
286
|
/**
|
|
207
287
|
* Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_path_part_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
|
|
208
288
|
* Update Document Handler
|
|
@@ -30,10 +30,9 @@ const index_1 = require("../models/index");
|
|
|
30
30
|
*/
|
|
31
31
|
class DocumentsApi extends runtime.BaseAPI {
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
34
|
-
* Create Document Handler
|
|
33
|
+
* Creates request options for createDocument without sending the request
|
|
35
34
|
*/
|
|
36
|
-
|
|
35
|
+
createDocumentRequestOpts(requestParameters) {
|
|
37
36
|
return __awaiter(this, void 0, void 0, function* () {
|
|
38
37
|
if (requestParameters['createDocumentRequest'] == null) {
|
|
39
38
|
throw new runtime.RequiredError('createDocumentRequest', 'Required parameter "createDocumentRequest" was null or undefined when calling createDocument().');
|
|
@@ -42,13 +41,23 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
42
41
|
const headerParameters = {};
|
|
43
42
|
headerParameters['Content-Type'] = 'application/json';
|
|
44
43
|
let urlPath = `/v1/documents`;
|
|
45
|
-
|
|
44
|
+
return {
|
|
46
45
|
path: urlPath,
|
|
47
46
|
method: 'POST',
|
|
48
47
|
headers: headerParameters,
|
|
49
48
|
query: queryParameters,
|
|
50
49
|
body: (0, index_1.CreateDocumentRequestToJSON)(requestParameters['createDocumentRequest']),
|
|
51
|
-
}
|
|
50
|
+
};
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Create a new document with initial v0 version. The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
|
|
55
|
+
* Create Document Handler
|
|
56
|
+
*/
|
|
57
|
+
createDocumentRaw(requestParameters, initOverrides) {
|
|
58
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
59
|
+
const requestOptions = yield this.createDocumentRequestOpts(requestParameters);
|
|
60
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
52
61
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DocumentResponseFromJSON)(jsonValue));
|
|
53
62
|
});
|
|
54
63
|
}
|
|
@@ -63,10 +72,9 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
63
72
|
});
|
|
64
73
|
}
|
|
65
74
|
/**
|
|
66
|
-
*
|
|
67
|
-
* Delete Document Handler
|
|
75
|
+
* Creates request options for deleteDocument without sending the request
|
|
68
76
|
*/
|
|
69
|
-
|
|
77
|
+
deleteDocumentRequestOpts(requestParameters) {
|
|
70
78
|
return __awaiter(this, void 0, void 0, function* () {
|
|
71
79
|
if (requestParameters['documentId'] == null) {
|
|
72
80
|
throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling deleteDocument().');
|
|
@@ -75,12 +83,22 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
75
83
|
const headerParameters = {};
|
|
76
84
|
let urlPath = `/v1/documents/{document_id}`;
|
|
77
85
|
urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
|
|
78
|
-
|
|
86
|
+
return {
|
|
79
87
|
path: urlPath,
|
|
80
88
|
method: 'DELETE',
|
|
81
89
|
headers: headerParameters,
|
|
82
90
|
query: queryParameters,
|
|
83
|
-
}
|
|
91
|
+
};
|
|
92
|
+
});
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Delete a document and all its contents. WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
|
|
96
|
+
* Delete Document Handler
|
|
97
|
+
*/
|
|
98
|
+
deleteDocumentRaw(requestParameters, initOverrides) {
|
|
99
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
100
|
+
const requestOptions = yield this.deleteDocumentRequestOpts(requestParameters);
|
|
101
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
84
102
|
return new runtime.VoidApiResponse(response);
|
|
85
103
|
});
|
|
86
104
|
}
|
|
@@ -94,10 +112,9 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
94
112
|
});
|
|
95
113
|
}
|
|
96
114
|
/**
|
|
97
|
-
*
|
|
98
|
-
* Get Document Handler
|
|
115
|
+
* Creates request options for getDocument without sending the request
|
|
99
116
|
*/
|
|
100
|
-
|
|
117
|
+
getDocumentRequestOpts(requestParameters) {
|
|
101
118
|
return __awaiter(this, void 0, void 0, function* () {
|
|
102
119
|
if (requestParameters['documentId'] == null) {
|
|
103
120
|
throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling getDocument().');
|
|
@@ -109,12 +126,22 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
109
126
|
const headerParameters = {};
|
|
110
127
|
let urlPath = `/v1/documents/{document_id}`;
|
|
111
128
|
urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
|
|
112
|
-
|
|
129
|
+
return {
|
|
113
130
|
path: urlPath,
|
|
114
131
|
method: 'GET',
|
|
115
132
|
headers: headerParameters,
|
|
116
133
|
query: queryParameters,
|
|
117
|
-
}
|
|
134
|
+
};
|
|
135
|
+
});
|
|
136
|
+
}
|
|
137
|
+
/**
|
|
138
|
+
* Get a document by its document ID.
|
|
139
|
+
* Get Document Handler
|
|
140
|
+
*/
|
|
141
|
+
getDocumentRaw(requestParameters, initOverrides) {
|
|
142
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
143
|
+
const requestOptions = yield this.getDocumentRequestOpts(requestParameters);
|
|
144
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
118
145
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DocumentResponseFromJSON)(jsonValue));
|
|
119
146
|
});
|
|
120
147
|
}
|
|
@@ -129,10 +156,9 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
129
156
|
});
|
|
130
157
|
}
|
|
131
158
|
/**
|
|
132
|
-
*
|
|
133
|
-
* Ingest Document Handler
|
|
159
|
+
* Creates request options for ingestDocument without sending the request
|
|
134
160
|
*/
|
|
135
|
-
|
|
161
|
+
ingestDocumentRequestOpts(requestParameters) {
|
|
136
162
|
return __awaiter(this, void 0, void 0, function* () {
|
|
137
163
|
if (requestParameters['file'] == null) {
|
|
138
164
|
throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling ingestDocument().');
|
|
@@ -167,13 +193,23 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
167
193
|
formParams.append('name', requestParameters['name']);
|
|
168
194
|
}
|
|
169
195
|
let urlPath = `/v1/documents/ingest`;
|
|
170
|
-
|
|
196
|
+
return {
|
|
171
197
|
path: urlPath,
|
|
172
198
|
method: 'POST',
|
|
173
199
|
headers: headerParameters,
|
|
174
200
|
query: queryParameters,
|
|
175
201
|
body: formParams,
|
|
176
|
-
}
|
|
202
|
+
};
|
|
203
|
+
});
|
|
204
|
+
}
|
|
205
|
+
/**
|
|
206
|
+
* 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.
|
|
207
|
+
* Ingest Document Handler
|
|
208
|
+
*/
|
|
209
|
+
ingestDocumentRaw(requestParameters, initOverrides) {
|
|
210
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
211
|
+
const requestOptions = yield this.ingestDocumentRequestOpts(requestParameters);
|
|
212
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
177
213
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.IngestDocumentResponseFromJSON)(jsonValue));
|
|
178
214
|
});
|
|
179
215
|
}
|
|
@@ -188,10 +224,9 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
188
224
|
});
|
|
189
225
|
}
|
|
190
226
|
/**
|
|
191
|
-
*
|
|
192
|
-
* List Documents Handler
|
|
227
|
+
* Creates request options for listDocuments without sending the request
|
|
193
228
|
*/
|
|
194
|
-
|
|
229
|
+
listDocumentsRequestOpts(requestParameters) {
|
|
195
230
|
return __awaiter(this, void 0, void 0, function* () {
|
|
196
231
|
const queryParameters = {};
|
|
197
232
|
if (requestParameters['parentPathPartId'] != null) {
|
|
@@ -211,12 +246,22 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
211
246
|
}
|
|
212
247
|
const headerParameters = {};
|
|
213
248
|
let urlPath = `/v1/documents`;
|
|
214
|
-
|
|
249
|
+
return {
|
|
215
250
|
path: urlPath,
|
|
216
251
|
method: 'GET',
|
|
217
252
|
headers: headerParameters,
|
|
218
253
|
query: queryParameters,
|
|
219
|
-
}
|
|
254
|
+
};
|
|
255
|
+
});
|
|
256
|
+
}
|
|
257
|
+
/**
|
|
258
|
+
* List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
|
|
259
|
+
* List Documents Handler
|
|
260
|
+
*/
|
|
261
|
+
listDocumentsRaw(requestParameters, initOverrides) {
|
|
262
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
263
|
+
const requestOptions = yield this.listDocumentsRequestOpts(requestParameters);
|
|
264
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
220
265
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseDocumentResponseFromJSON)(jsonValue));
|
|
221
266
|
});
|
|
222
267
|
}
|
|
@@ -231,10 +276,9 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
231
276
|
});
|
|
232
277
|
}
|
|
233
278
|
/**
|
|
234
|
-
*
|
|
235
|
-
* Update Document Handler
|
|
279
|
+
* Creates request options for updateDocument without sending the request
|
|
236
280
|
*/
|
|
237
|
-
|
|
281
|
+
updateDocumentRequestOpts(requestParameters) {
|
|
238
282
|
return __awaiter(this, void 0, void 0, function* () {
|
|
239
283
|
if (requestParameters['documentId'] == null) {
|
|
240
284
|
throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling updateDocument().');
|
|
@@ -247,13 +291,23 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
247
291
|
headerParameters['Content-Type'] = 'application/json';
|
|
248
292
|
let urlPath = `/v1/documents/{document_id}`;
|
|
249
293
|
urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
|
|
250
|
-
|
|
294
|
+
return {
|
|
251
295
|
path: urlPath,
|
|
252
296
|
method: 'PATCH',
|
|
253
297
|
headers: headerParameters,
|
|
254
298
|
query: queryParameters,
|
|
255
299
|
body: (0, index_1.UpdateDocumentRequestToJSON)(requestParameters['updateDocumentRequest']),
|
|
256
|
-
}
|
|
300
|
+
};
|
|
301
|
+
});
|
|
302
|
+
}
|
|
303
|
+
/**
|
|
304
|
+
* Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_path_part_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
|
|
305
|
+
* Update Document Handler
|
|
306
|
+
*/
|
|
307
|
+
updateDocumentRaw(requestParameters, initOverrides) {
|
|
308
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
309
|
+
const requestOptions = yield this.updateDocumentRequestOpts(requestParameters);
|
|
310
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
257
311
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DocumentResponseFromJSON)(jsonValue));
|
|
258
312
|
});
|
|
259
313
|
}
|
|
@@ -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,
|
|
13
|
+
import type { CreateFolderRequest, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator, PaginatedResponseFolderResponse, PathOrder, UpdateFolderRequest } from '../models/index';
|
|
14
14
|
export interface CreateFolderOperationRequest {
|
|
15
15
|
createFolderRequest: CreateFolderRequest;
|
|
16
16
|
ksUat?: string | null;
|
|
@@ -53,6 +53,14 @@ export interface UpdateFolderOperationRequest {
|
|
|
53
53
|
* @interface FoldersApiInterface
|
|
54
54
|
*/
|
|
55
55
|
export interface FoldersApiInterface {
|
|
56
|
+
/**
|
|
57
|
+
* Creates request options for createFolder without sending the request
|
|
58
|
+
* @param {CreateFolderRequest} createFolderRequest
|
|
59
|
+
* @param {string} [ksUat]
|
|
60
|
+
* @throws {RequiredError}
|
|
61
|
+
* @memberof FoldersApiInterface
|
|
62
|
+
*/
|
|
63
|
+
createFolderRequestOpts(requestParameters: CreateFolderOperationRequest): Promise<runtime.RequestOpts>;
|
|
56
64
|
/**
|
|
57
65
|
* Create a new folder. The folder is created as a child of the specified parent folder. It is automatically added to the end of the parent\'s children list.
|
|
58
66
|
* @summary Create Folder Handler
|
|
@@ -68,6 +76,14 @@ export interface FoldersApiInterface {
|
|
|
68
76
|
* Create Folder Handler
|
|
69
77
|
*/
|
|
70
78
|
createFolder(requestParameters: CreateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
|
|
79
|
+
/**
|
|
80
|
+
* Creates request options for deleteFolder without sending the request
|
|
81
|
+
* @param {string} folderId
|
|
82
|
+
* @param {string} [ksUat]
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
* @memberof FoldersApiInterface
|
|
85
|
+
*/
|
|
86
|
+
deleteFolderRequestOpts(requestParameters: DeleteFolderRequest): Promise<runtime.RequestOpts>;
|
|
71
87
|
/**
|
|
72
88
|
* Delete a folder and all its contents. WARNING: This cascades to all children due to parent_id ON DELETE CASCADE. The root folder cannot be deleted.
|
|
73
89
|
* @summary Delete Folder Handler
|
|
@@ -83,6 +99,15 @@ export interface FoldersApiInterface {
|
|
|
83
99
|
* Delete Folder Handler
|
|
84
100
|
*/
|
|
85
101
|
deleteFolder(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
102
|
+
/**
|
|
103
|
+
* Creates request options for getFolder without sending the request
|
|
104
|
+
* @param {string} folderId
|
|
105
|
+
* @param {boolean} [withTags] Include tags in the response (default: false)
|
|
106
|
+
* @param {string} [ksUat]
|
|
107
|
+
* @throws {RequiredError}
|
|
108
|
+
* @memberof FoldersApiInterface
|
|
109
|
+
*/
|
|
110
|
+
getFolderRequestOpts(requestParameters: GetFolderRequest): Promise<runtime.RequestOpts>;
|
|
86
111
|
/**
|
|
87
112
|
* Get a folder by its folder ID.
|
|
88
113
|
* @summary Get Folder Handler
|
|
@@ -100,7 +125,20 @@ export interface FoldersApiInterface {
|
|
|
100
125
|
*/
|
|
101
126
|
getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
|
|
102
127
|
/**
|
|
103
|
-
*
|
|
128
|
+
* Creates request options for listFolderContents without sending the request
|
|
129
|
+
* @param {string} folderId
|
|
130
|
+
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
131
|
+
* @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
132
|
+
* @param {boolean} [withTags] Include tag IDs for each item (default: false)
|
|
133
|
+
* @param {number} [limit] Number of items per page
|
|
134
|
+
* @param {number} [offset] Number of items to skip
|
|
135
|
+
* @param {string} [ksUat]
|
|
136
|
+
* @throws {RequiredError}
|
|
137
|
+
* @memberof FoldersApiInterface
|
|
138
|
+
*/
|
|
139
|
+
listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
|
|
140
|
+
/**
|
|
141
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). 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.
|
|
104
142
|
* @summary List Folder Contents Handler
|
|
105
143
|
* @param {string} folderId
|
|
106
144
|
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
@@ -113,12 +151,24 @@ export interface FoldersApiInterface {
|
|
|
113
151
|
* @throws {RequiredError}
|
|
114
152
|
* @memberof FoldersApiInterface
|
|
115
153
|
*/
|
|
116
|
-
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
154
|
+
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>>;
|
|
117
155
|
/**
|
|
118
|
-
* List all contents (folders and documents) under a folder. Returns
|
|
156
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). 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.
|
|
119
157
|
* List Folder Contents Handler
|
|
120
158
|
*/
|
|
121
|
-
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
159
|
+
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>;
|
|
160
|
+
/**
|
|
161
|
+
* Creates request options for listFolders without sending the request
|
|
162
|
+
* @param {string} [parentPathPartId] Parent PathPart ID (defaults to root)
|
|
163
|
+
* @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
164
|
+
* @param {boolean} [withTags] Include tags in the response (default: false)
|
|
165
|
+
* @param {number} [limit] Number of items per page
|
|
166
|
+
* @param {number} [offset] Number of items to skip
|
|
167
|
+
* @param {string} [ksUat]
|
|
168
|
+
* @throws {RequiredError}
|
|
169
|
+
* @memberof FoldersApiInterface
|
|
170
|
+
*/
|
|
171
|
+
listFoldersRequestOpts(requestParameters: ListFoldersRequest): Promise<runtime.RequestOpts>;
|
|
122
172
|
/**
|
|
123
173
|
* List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists top-level folders. At root level, the /users folder is hidden and replaced with the current user\'s personal folder (/users/{user_id}) displayed as \"Personal\".
|
|
124
174
|
* @summary List Folders Handler
|
|
@@ -138,6 +188,15 @@ export interface FoldersApiInterface {
|
|
|
138
188
|
* List Folders Handler
|
|
139
189
|
*/
|
|
140
190
|
listFolders(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
|
|
191
|
+
/**
|
|
192
|
+
* Creates request options for updateFolder without sending the request
|
|
193
|
+
* @param {string} folderId
|
|
194
|
+
* @param {UpdateFolderRequest} updateFolderRequest
|
|
195
|
+
* @param {string} [ksUat]
|
|
196
|
+
* @throws {RequiredError}
|
|
197
|
+
* @memberof FoldersApiInterface
|
|
198
|
+
*/
|
|
199
|
+
updateFolderRequestOpts(requestParameters: UpdateFolderOperationRequest): Promise<runtime.RequestOpts>;
|
|
141
200
|
/**
|
|
142
201
|
* Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_path_part_id` field. Both can be done in a single request.
|
|
143
202
|
* @summary Update Folder Handler
|
|
@@ -159,6 +218,10 @@ export interface FoldersApiInterface {
|
|
|
159
218
|
*
|
|
160
219
|
*/
|
|
161
220
|
export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
221
|
+
/**
|
|
222
|
+
* Creates request options for createFolder without sending the request
|
|
223
|
+
*/
|
|
224
|
+
createFolderRequestOpts(requestParameters: CreateFolderOperationRequest): Promise<runtime.RequestOpts>;
|
|
162
225
|
/**
|
|
163
226
|
* Create a new folder. The folder is created as a child of the specified parent folder. It is automatically added to the end of the parent\'s children list.
|
|
164
227
|
* Create Folder Handler
|
|
@@ -169,6 +232,10 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
|
|
|
169
232
|
* Create Folder Handler
|
|
170
233
|
*/
|
|
171
234
|
createFolder(requestParameters: CreateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
|
|
235
|
+
/**
|
|
236
|
+
* Creates request options for deleteFolder without sending the request
|
|
237
|
+
*/
|
|
238
|
+
deleteFolderRequestOpts(requestParameters: DeleteFolderRequest): Promise<runtime.RequestOpts>;
|
|
172
239
|
/**
|
|
173
240
|
* Delete a folder and all its contents. WARNING: This cascades to all children due to parent_id ON DELETE CASCADE. The root folder cannot be deleted.
|
|
174
241
|
* Delete Folder Handler
|
|
@@ -179,6 +246,10 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
|
|
|
179
246
|
* Delete Folder Handler
|
|
180
247
|
*/
|
|
181
248
|
deleteFolder(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
249
|
+
/**
|
|
250
|
+
* Creates request options for getFolder without sending the request
|
|
251
|
+
*/
|
|
252
|
+
getFolderRequestOpts(requestParameters: GetFolderRequest): Promise<runtime.RequestOpts>;
|
|
182
253
|
/**
|
|
183
254
|
* Get a folder by its folder ID.
|
|
184
255
|
* Get Folder Handler
|
|
@@ -190,15 +261,23 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
|
|
|
190
261
|
*/
|
|
191
262
|
getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
|
|
192
263
|
/**
|
|
193
|
-
*
|
|
264
|
+
* Creates request options for listFolderContents without sending the request
|
|
265
|
+
*/
|
|
266
|
+
listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
|
|
267
|
+
/**
|
|
268
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). 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.
|
|
194
269
|
* List Folder Contents Handler
|
|
195
270
|
*/
|
|
196
|
-
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
271
|
+
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>>;
|
|
197
272
|
/**
|
|
198
|
-
* List all contents (folders and documents) under a folder. Returns
|
|
273
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). 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.
|
|
199
274
|
* List Folder Contents Handler
|
|
200
275
|
*/
|
|
201
|
-
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
276
|
+
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>;
|
|
277
|
+
/**
|
|
278
|
+
* Creates request options for listFolders without sending the request
|
|
279
|
+
*/
|
|
280
|
+
listFoldersRequestOpts(requestParameters: ListFoldersRequest): Promise<runtime.RequestOpts>;
|
|
202
281
|
/**
|
|
203
282
|
* List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists top-level folders. At root level, the /users folder is hidden and replaced with the current user\'s personal folder (/users/{user_id}) displayed as \"Personal\".
|
|
204
283
|
* List Folders Handler
|
|
@@ -209,6 +288,10 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
|
|
|
209
288
|
* List Folders Handler
|
|
210
289
|
*/
|
|
211
290
|
listFolders(requestParameters?: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
|
|
291
|
+
/**
|
|
292
|
+
* Creates request options for updateFolder without sending the request
|
|
293
|
+
*/
|
|
294
|
+
updateFolderRequestOpts(requestParameters: UpdateFolderOperationRequest): Promise<runtime.RequestOpts>;
|
|
212
295
|
/**
|
|
213
296
|
* Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_path_part_id` field. Both can be done in a single request.
|
|
214
297
|
* Update Folder Handler
|