@knowledge-stack/ksapi 1.23.5 → 1.25.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 +130 -4
- package/.openapi-generator/VERSION +1 -1
- package/README.md +282 -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 +161 -5
- package/dist/apis/ChunksApi.js +168 -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 +140 -1
- package/dist/apis/PathPartsApi.js +141 -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 +103 -0
- package/dist/apis/TenantsApi.js +112 -40
- 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 +161 -5
- package/dist/esm/apis/ChunksApi.js +169 -32
- 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 +140 -1
- package/dist/esm/apis/PathPartsApi.js +142 -21
- 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 +103 -0
- package/dist/esm/apis/TenantsApi.js +112 -40
- 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/ChunkBulkResponse.d.ts +139 -0
- package/dist/esm/models/ChunkBulkResponse.js +100 -0
- package/dist/esm/models/{DocumentContentPathPart.d.ts → ChunkContentItem.d.ts} +37 -40
- package/dist/esm/models/{DocumentContentPathPart.js → ChunkContentItem.js} +19 -16
- package/dist/esm/models/ChunkSearchRequest.d.ts +14 -2
- package/dist/esm/models/ChunkSearchRequest.js +6 -2
- package/dist/esm/models/DocumentResponse.d.ts +13 -0
- package/dist/esm/models/DocumentResponse.js +10 -0
- package/dist/esm/models/FolderResponse.d.ts +13 -0
- package/dist/esm/models/FolderResponse.js +10 -0
- package/dist/esm/models/FolderResponseOrDocumentResponse.d.ts +27 -0
- package/dist/esm/models/FolderResponseOrDocumentResponse.js +47 -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/SectionContentItem.d.ts +114 -0
- package/dist/esm/models/SectionContentItem.js +88 -0
- package/dist/esm/models/SectionContentItemOrChunkContentItem.d.ts +27 -0
- package/dist/esm/models/SectionContentItemOrChunkContentItem.js +47 -0
- package/dist/esm/models/SubtreeChunkGroup.d.ts +62 -0
- package/dist/esm/models/SubtreeChunkGroup.js +52 -0
- package/dist/esm/models/SubtreeChunksResponse.d.ts +48 -0
- package/dist/esm/models/SubtreeChunksResponse.js +45 -0
- package/dist/esm/models/VersionChunkIdsResponse.d.ts +47 -0
- package/dist/esm/models/VersionChunkIdsResponse.js +44 -0
- package/dist/esm/models/index.d.ts +10 -4
- package/dist/esm/models/index.js +10 -4
- package/dist/models/ChunkBulkResponse.d.ts +139 -0
- package/dist/models/ChunkBulkResponse.js +108 -0
- package/dist/models/{DocumentContentPathPart.d.ts → ChunkContentItem.d.ts} +37 -40
- package/dist/models/{DocumentContentPathPart.js → ChunkContentItem.js} +25 -22
- package/dist/models/ChunkSearchRequest.d.ts +14 -2
- package/dist/models/ChunkSearchRequest.js +6 -2
- package/dist/models/DocumentResponse.d.ts +13 -0
- package/dist/models/DocumentResponse.js +11 -1
- package/dist/models/FolderResponse.d.ts +13 -0
- package/dist/models/FolderResponse.js +11 -1
- package/dist/models/FolderResponseOrDocumentResponse.d.ts +27 -0
- package/dist/models/FolderResponseOrDocumentResponse.js +53 -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/SectionContentItem.d.ts +114 -0
- package/dist/models/SectionContentItem.js +96 -0
- package/dist/models/SectionContentItemOrChunkContentItem.d.ts +27 -0
- package/dist/models/SectionContentItemOrChunkContentItem.js +53 -0
- package/dist/models/SubtreeChunkGroup.d.ts +62 -0
- package/dist/models/SubtreeChunkGroup.js +60 -0
- package/dist/models/SubtreeChunksResponse.d.ts +48 -0
- package/dist/models/SubtreeChunksResponse.js +53 -0
- package/dist/models/VersionChunkIdsResponse.d.ts +47 -0
- package/dist/models/VersionChunkIdsResponse.js +52 -0
- package/dist/models/index.d.ts +10 -4
- package/dist/models/index.js +10 -4
- package/docs/AuthApi.md +707 -0
- package/docs/BulkTagRequest.md +35 -0
- package/docs/ChunkBulkResponse.md +65 -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 +51 -0
- package/docs/ChunkType.md +33 -0
- package/docs/ChunksApi.md +590 -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 +461 -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/SubtreeChunkGroup.md +39 -0
- package/docs/SubtreeChunksResponse.md +35 -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/VersionChunkIdsResponse.md +35 -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 +298 -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 +260 -20
- package/src/apis/SectionsApi.ts +89 -20
- package/src/apis/TagsApi.ts +112 -25
- package/src/apis/TenantsApi.ts +183 -40
- 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/ChunkBulkResponse.ts +232 -0
- package/src/models/{DocumentContentPathPart.ts → ChunkContentItem.ts} +43 -53
- package/src/models/ChunkSearchRequest.ts +20 -4
- package/src/models/DocumentResponse.ts +17 -0
- package/src/models/FolderResponse.ts +19 -0
- package/src/models/FolderResponseOrDocumentResponse.ts +72 -0
- package/src/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.ts +130 -0
- package/src/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.ts +130 -0
- package/src/models/SectionContentItem.ts +182 -0
- package/src/models/SectionContentItemOrChunkContentItem.ts +72 -0
- package/src/models/SubtreeChunkGroup.ts +104 -0
- package/src/models/SubtreeChunksResponse.ts +91 -0
- package/src/models/VersionChunkIdsResponse.ts +83 -0
- package/src/models/index.ts +10 -4
- 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/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/src/models/FolderDocumentResponse.ts +0 -267
- package/src/models/PaginatedResponseDocumentContentPathPart.ts +0 -130
- package/src/models/PaginatedResponseFolderDocumentResponse.ts +0 -130
package/src/apis/PathPartsApi.ts
CHANGED
|
@@ -21,6 +21,7 @@ import type {
|
|
|
21
21
|
PathOrder,
|
|
22
22
|
PathPartResponse,
|
|
23
23
|
PathPartTagsResponse,
|
|
24
|
+
SubtreeChunksResponse,
|
|
24
25
|
} from '../models/index';
|
|
25
26
|
import {
|
|
26
27
|
BulkTagRequestFromJSON,
|
|
@@ -35,6 +36,8 @@ import {
|
|
|
35
36
|
PathPartResponseToJSON,
|
|
36
37
|
PathPartTagsResponseFromJSON,
|
|
37
38
|
PathPartTagsResponseToJSON,
|
|
39
|
+
SubtreeChunksResponseFromJSON,
|
|
40
|
+
SubtreeChunksResponseToJSON,
|
|
38
41
|
} from '../models/index';
|
|
39
42
|
|
|
40
43
|
export interface BulkAddPathPartTagsRequest {
|
|
@@ -54,6 +57,17 @@ export interface GetPathPartRequest {
|
|
|
54
57
|
ksUat?: string | null;
|
|
55
58
|
}
|
|
56
59
|
|
|
60
|
+
export interface GetPathPartSubtreeChunksRequest {
|
|
61
|
+
pathPartId: string;
|
|
62
|
+
ksUat?: string | null;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export interface GetPathPartTagsRequest {
|
|
66
|
+
pathPartId: string;
|
|
67
|
+
includeInherited?: boolean;
|
|
68
|
+
ksUat?: string | null;
|
|
69
|
+
}
|
|
70
|
+
|
|
57
71
|
export interface ListPathPartsRequest {
|
|
58
72
|
parentPathId?: string | null;
|
|
59
73
|
maxDepth?: number;
|
|
@@ -70,6 +84,16 @@ export interface ListPathPartsRequest {
|
|
|
70
84
|
* @interface PathPartsApiInterface
|
|
71
85
|
*/
|
|
72
86
|
export interface PathPartsApiInterface {
|
|
87
|
+
/**
|
|
88
|
+
* Creates request options for bulkAddPathPartTags without sending the request
|
|
89
|
+
* @param {string} pathPartId
|
|
90
|
+
* @param {BulkTagRequest} bulkTagRequest
|
|
91
|
+
* @param {string} [ksUat]
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
* @memberof PathPartsApiInterface
|
|
94
|
+
*/
|
|
95
|
+
bulkAddPathPartTagsRequestOpts(requestParameters: BulkAddPathPartTagsRequest): Promise<runtime.RequestOpts>;
|
|
96
|
+
|
|
73
97
|
/**
|
|
74
98
|
* Bulk add tags to a path part. Idempotent — already-attached tags are skipped. Returns 400 if any tag_id doesn\'t exist (FK violation). Requires write permission on the target path part.
|
|
75
99
|
* @summary Bulk Add Path Part Tags Handler
|
|
@@ -88,6 +112,16 @@ export interface PathPartsApiInterface {
|
|
|
88
112
|
*/
|
|
89
113
|
bulkAddPathPartTags(requestParameters: BulkAddPathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartTagsResponse>;
|
|
90
114
|
|
|
115
|
+
/**
|
|
116
|
+
* Creates request options for bulkRemovePathPartTags without sending the request
|
|
117
|
+
* @param {string} pathPartId
|
|
118
|
+
* @param {BulkTagRequest} bulkTagRequest
|
|
119
|
+
* @param {string} [ksUat]
|
|
120
|
+
* @throws {RequiredError}
|
|
121
|
+
* @memberof PathPartsApiInterface
|
|
122
|
+
*/
|
|
123
|
+
bulkRemovePathPartTagsRequestOpts(requestParameters: BulkRemovePathPartTagsRequest): Promise<runtime.RequestOpts>;
|
|
124
|
+
|
|
91
125
|
/**
|
|
92
126
|
* Bulk remove tags from a path part. Silently ignores tags that aren\'t attached. Requires write permission on the target path part.
|
|
93
127
|
* @summary Bulk Remove Path Part Tags Handler
|
|
@@ -106,6 +140,15 @@ export interface PathPartsApiInterface {
|
|
|
106
140
|
*/
|
|
107
141
|
bulkRemovePathPartTags(requestParameters: BulkRemovePathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartTagsResponse>;
|
|
108
142
|
|
|
143
|
+
/**
|
|
144
|
+
* Creates request options for getPathPart without sending the request
|
|
145
|
+
* @param {string} pathPartId
|
|
146
|
+
* @param {string} [ksUat]
|
|
147
|
+
* @throws {RequiredError}
|
|
148
|
+
* @memberof PathPartsApiInterface
|
|
149
|
+
*/
|
|
150
|
+
getPathPartRequestOpts(requestParameters: GetPathPartRequest): Promise<runtime.RequestOpts>;
|
|
151
|
+
|
|
109
152
|
/**
|
|
110
153
|
* Get a path part by its ID. Returns the path part with its attached tag IDs.
|
|
111
154
|
* @summary Get Path Part Handler
|
|
@@ -123,6 +166,73 @@ export interface PathPartsApiInterface {
|
|
|
123
166
|
*/
|
|
124
167
|
getPathPart(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse>;
|
|
125
168
|
|
|
169
|
+
/**
|
|
170
|
+
* Creates request options for getPathPartSubtreeChunks without sending the request
|
|
171
|
+
* @param {string} pathPartId
|
|
172
|
+
* @param {string} [ksUat]
|
|
173
|
+
* @throws {RequiredError}
|
|
174
|
+
* @memberof PathPartsApiInterface
|
|
175
|
+
*/
|
|
176
|
+
getPathPartSubtreeChunksRequestOpts(requestParameters: GetPathPartSubtreeChunksRequest): Promise<runtime.RequestOpts>;
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Resolve all descendant chunks for a subtree root. Returns chunks grouped by identical (path_part_ids, tag_ids) tuples.
|
|
180
|
+
* @summary Get Path Part Subtree Chunks Handler
|
|
181
|
+
* @param {string} pathPartId
|
|
182
|
+
* @param {string} [ksUat]
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
* @memberof PathPartsApiInterface
|
|
186
|
+
*/
|
|
187
|
+
getPathPartSubtreeChunksRaw(requestParameters: GetPathPartSubtreeChunksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubtreeChunksResponse>>;
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* Resolve all descendant chunks for a subtree root. Returns chunks grouped by identical (path_part_ids, tag_ids) tuples.
|
|
191
|
+
* Get Path Part Subtree Chunks Handler
|
|
192
|
+
*/
|
|
193
|
+
getPathPartSubtreeChunks(requestParameters: GetPathPartSubtreeChunksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubtreeChunksResponse>;
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* Creates request options for getPathPartTags without sending the request
|
|
197
|
+
* @param {string} pathPartId
|
|
198
|
+
* @param {boolean} [includeInherited] Include tags inherited from ancestor path parts
|
|
199
|
+
* @param {string} [ksUat]
|
|
200
|
+
* @throws {RequiredError}
|
|
201
|
+
* @memberof PathPartsApiInterface
|
|
202
|
+
*/
|
|
203
|
+
getPathPartTagsRequestOpts(requestParameters: GetPathPartTagsRequest): Promise<runtime.RequestOpts>;
|
|
204
|
+
|
|
205
|
+
/**
|
|
206
|
+
* Get tags for a path part. When include_inherited=False (default), returns only directly-attached tags. When include_inherited=True, walks the ancestor chain and returns the deduplicated union of tags from all ancestors (including the path part itself).
|
|
207
|
+
* @summary Get Path Part Tags Handler
|
|
208
|
+
* @param {string} pathPartId
|
|
209
|
+
* @param {boolean} [includeInherited] Include tags inherited from ancestor path parts
|
|
210
|
+
* @param {string} [ksUat]
|
|
211
|
+
* @param {*} [options] Override http request option.
|
|
212
|
+
* @throws {RequiredError}
|
|
213
|
+
* @memberof PathPartsApiInterface
|
|
214
|
+
*/
|
|
215
|
+
getPathPartTagsRaw(requestParameters: GetPathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartTagsResponse>>;
|
|
216
|
+
|
|
217
|
+
/**
|
|
218
|
+
* Get tags for a path part. When include_inherited=False (default), returns only directly-attached tags. When include_inherited=True, walks the ancestor chain and returns the deduplicated union of tags from all ancestors (including the path part itself).
|
|
219
|
+
* Get Path Part Tags Handler
|
|
220
|
+
*/
|
|
221
|
+
getPathPartTags(requestParameters: GetPathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartTagsResponse>;
|
|
222
|
+
|
|
223
|
+
/**
|
|
224
|
+
* Creates request options for listPathParts without sending the request
|
|
225
|
+
* @param {string} [parentPathId] Parent PathPart ID (defaults to root)
|
|
226
|
+
* @param {number} [maxDepth] Maximum depth to traverse (1 = direct children, default: 1)
|
|
227
|
+
* @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
228
|
+
* @param {number} [limit] Number of items per page
|
|
229
|
+
* @param {number} [offset] Number of items to skip
|
|
230
|
+
* @param {string} [ksUat]
|
|
231
|
+
* @throws {RequiredError}
|
|
232
|
+
* @memberof PathPartsApiInterface
|
|
233
|
+
*/
|
|
234
|
+
listPathPartsRequestOpts(requestParameters: ListPathPartsRequest): Promise<runtime.RequestOpts>;
|
|
235
|
+
|
|
126
236
|
/**
|
|
127
237
|
* 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_path_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.
|
|
128
238
|
* @summary List Path Parts Handler
|
|
@@ -152,10 +262,9 @@ export interface PathPartsApiInterface {
|
|
|
152
262
|
export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterface {
|
|
153
263
|
|
|
154
264
|
/**
|
|
155
|
-
*
|
|
156
|
-
* Bulk Add Path Part Tags Handler
|
|
265
|
+
* Creates request options for bulkAddPathPartTags without sending the request
|
|
157
266
|
*/
|
|
158
|
-
async
|
|
267
|
+
async bulkAddPathPartTagsRequestOpts(requestParameters: BulkAddPathPartTagsRequest): Promise<runtime.RequestOpts> {
|
|
159
268
|
if (requestParameters['pathPartId'] == null) {
|
|
160
269
|
throw new runtime.RequiredError(
|
|
161
270
|
'pathPartId',
|
|
@@ -180,13 +289,22 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
|
|
|
180
289
|
let urlPath = `/v1/path-parts/{path_part_id}/tags`;
|
|
181
290
|
urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
|
|
182
291
|
|
|
183
|
-
|
|
292
|
+
return {
|
|
184
293
|
path: urlPath,
|
|
185
294
|
method: 'POST',
|
|
186
295
|
headers: headerParameters,
|
|
187
296
|
query: queryParameters,
|
|
188
297
|
body: BulkTagRequestToJSON(requestParameters['bulkTagRequest']),
|
|
189
|
-
}
|
|
298
|
+
};
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
/**
|
|
302
|
+
* Bulk add tags to a path part. Idempotent — already-attached tags are skipped. Returns 400 if any tag_id doesn\'t exist (FK violation). Requires write permission on the target path part.
|
|
303
|
+
* Bulk Add Path Part Tags Handler
|
|
304
|
+
*/
|
|
305
|
+
async bulkAddPathPartTagsRaw(requestParameters: BulkAddPathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartTagsResponse>> {
|
|
306
|
+
const requestOptions = await this.bulkAddPathPartTagsRequestOpts(requestParameters);
|
|
307
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
190
308
|
|
|
191
309
|
return new runtime.JSONApiResponse(response, (jsonValue) => PathPartTagsResponseFromJSON(jsonValue));
|
|
192
310
|
}
|
|
@@ -201,10 +319,9 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
|
|
|
201
319
|
}
|
|
202
320
|
|
|
203
321
|
/**
|
|
204
|
-
*
|
|
205
|
-
* Bulk Remove Path Part Tags Handler
|
|
322
|
+
* Creates request options for bulkRemovePathPartTags without sending the request
|
|
206
323
|
*/
|
|
207
|
-
async
|
|
324
|
+
async bulkRemovePathPartTagsRequestOpts(requestParameters: BulkRemovePathPartTagsRequest): Promise<runtime.RequestOpts> {
|
|
208
325
|
if (requestParameters['pathPartId'] == null) {
|
|
209
326
|
throw new runtime.RequiredError(
|
|
210
327
|
'pathPartId',
|
|
@@ -229,13 +346,22 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
|
|
|
229
346
|
let urlPath = `/v1/path-parts/{path_part_id}/tags`;
|
|
230
347
|
urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
|
|
231
348
|
|
|
232
|
-
|
|
349
|
+
return {
|
|
233
350
|
path: urlPath,
|
|
234
351
|
method: 'DELETE',
|
|
235
352
|
headers: headerParameters,
|
|
236
353
|
query: queryParameters,
|
|
237
354
|
body: BulkTagRequestToJSON(requestParameters['bulkTagRequest']),
|
|
238
|
-
}
|
|
355
|
+
};
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
/**
|
|
359
|
+
* Bulk remove tags from a path part. Silently ignores tags that aren\'t attached. Requires write permission on the target path part.
|
|
360
|
+
* Bulk Remove Path Part Tags Handler
|
|
361
|
+
*/
|
|
362
|
+
async bulkRemovePathPartTagsRaw(requestParameters: BulkRemovePathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartTagsResponse>> {
|
|
363
|
+
const requestOptions = await this.bulkRemovePathPartTagsRequestOpts(requestParameters);
|
|
364
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
239
365
|
|
|
240
366
|
return new runtime.JSONApiResponse(response, (jsonValue) => PathPartTagsResponseFromJSON(jsonValue));
|
|
241
367
|
}
|
|
@@ -250,10 +376,9 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
|
|
|
250
376
|
}
|
|
251
377
|
|
|
252
378
|
/**
|
|
253
|
-
*
|
|
254
|
-
* Get Path Part Handler
|
|
379
|
+
* Creates request options for getPathPart without sending the request
|
|
255
380
|
*/
|
|
256
|
-
async
|
|
381
|
+
async getPathPartRequestOpts(requestParameters: GetPathPartRequest): Promise<runtime.RequestOpts> {
|
|
257
382
|
if (requestParameters['pathPartId'] == null) {
|
|
258
383
|
throw new runtime.RequiredError(
|
|
259
384
|
'pathPartId',
|
|
@@ -269,12 +394,21 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
|
|
|
269
394
|
let urlPath = `/v1/path-parts/{path_part_id}`;
|
|
270
395
|
urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
|
|
271
396
|
|
|
272
|
-
|
|
397
|
+
return {
|
|
273
398
|
path: urlPath,
|
|
274
399
|
method: 'GET',
|
|
275
400
|
headers: headerParameters,
|
|
276
401
|
query: queryParameters,
|
|
277
|
-
}
|
|
402
|
+
};
|
|
403
|
+
}
|
|
404
|
+
|
|
405
|
+
/**
|
|
406
|
+
* Get a path part by its ID. Returns the path part with its attached tag IDs.
|
|
407
|
+
* Get Path Part Handler
|
|
408
|
+
*/
|
|
409
|
+
async getPathPartRaw(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartResponse>> {
|
|
410
|
+
const requestOptions = await this.getPathPartRequestOpts(requestParameters);
|
|
411
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
278
412
|
|
|
279
413
|
return new runtime.JSONApiResponse(response, (jsonValue) => PathPartResponseFromJSON(jsonValue));
|
|
280
414
|
}
|
|
@@ -289,10 +423,107 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
|
|
|
289
423
|
}
|
|
290
424
|
|
|
291
425
|
/**
|
|
292
|
-
*
|
|
293
|
-
* List Path Parts Handler
|
|
426
|
+
* Creates request options for getPathPartSubtreeChunks without sending the request
|
|
294
427
|
*/
|
|
295
|
-
async
|
|
428
|
+
async getPathPartSubtreeChunksRequestOpts(requestParameters: GetPathPartSubtreeChunksRequest): Promise<runtime.RequestOpts> {
|
|
429
|
+
if (requestParameters['pathPartId'] == null) {
|
|
430
|
+
throw new runtime.RequiredError(
|
|
431
|
+
'pathPartId',
|
|
432
|
+
'Required parameter "pathPartId" was null or undefined when calling getPathPartSubtreeChunks().'
|
|
433
|
+
);
|
|
434
|
+
}
|
|
435
|
+
|
|
436
|
+
const queryParameters: any = {};
|
|
437
|
+
|
|
438
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
let urlPath = `/v1/path-parts/{path_part_id}/subtree_chunks`;
|
|
442
|
+
urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
|
|
443
|
+
|
|
444
|
+
return {
|
|
445
|
+
path: urlPath,
|
|
446
|
+
method: 'GET',
|
|
447
|
+
headers: headerParameters,
|
|
448
|
+
query: queryParameters,
|
|
449
|
+
};
|
|
450
|
+
}
|
|
451
|
+
|
|
452
|
+
/**
|
|
453
|
+
* Resolve all descendant chunks for a subtree root. Returns chunks grouped by identical (path_part_ids, tag_ids) tuples.
|
|
454
|
+
* Get Path Part Subtree Chunks Handler
|
|
455
|
+
*/
|
|
456
|
+
async getPathPartSubtreeChunksRaw(requestParameters: GetPathPartSubtreeChunksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubtreeChunksResponse>> {
|
|
457
|
+
const requestOptions = await this.getPathPartSubtreeChunksRequestOpts(requestParameters);
|
|
458
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
459
|
+
|
|
460
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => SubtreeChunksResponseFromJSON(jsonValue));
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
/**
|
|
464
|
+
* Resolve all descendant chunks for a subtree root. Returns chunks grouped by identical (path_part_ids, tag_ids) tuples.
|
|
465
|
+
* Get Path Part Subtree Chunks Handler
|
|
466
|
+
*/
|
|
467
|
+
async getPathPartSubtreeChunks(requestParameters: GetPathPartSubtreeChunksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubtreeChunksResponse> {
|
|
468
|
+
const response = await this.getPathPartSubtreeChunksRaw(requestParameters, initOverrides);
|
|
469
|
+
return await response.value();
|
|
470
|
+
}
|
|
471
|
+
|
|
472
|
+
/**
|
|
473
|
+
* Creates request options for getPathPartTags without sending the request
|
|
474
|
+
*/
|
|
475
|
+
async getPathPartTagsRequestOpts(requestParameters: GetPathPartTagsRequest): Promise<runtime.RequestOpts> {
|
|
476
|
+
if (requestParameters['pathPartId'] == null) {
|
|
477
|
+
throw new runtime.RequiredError(
|
|
478
|
+
'pathPartId',
|
|
479
|
+
'Required parameter "pathPartId" was null or undefined when calling getPathPartTags().'
|
|
480
|
+
);
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
const queryParameters: any = {};
|
|
484
|
+
|
|
485
|
+
if (requestParameters['includeInherited'] != null) {
|
|
486
|
+
queryParameters['include_inherited'] = requestParameters['includeInherited'];
|
|
487
|
+
}
|
|
488
|
+
|
|
489
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
let urlPath = `/v1/path-parts/{path_part_id}/tags`;
|
|
493
|
+
urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
|
|
494
|
+
|
|
495
|
+
return {
|
|
496
|
+
path: urlPath,
|
|
497
|
+
method: 'GET',
|
|
498
|
+
headers: headerParameters,
|
|
499
|
+
query: queryParameters,
|
|
500
|
+
};
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
/**
|
|
504
|
+
* Get tags for a path part. When include_inherited=False (default), returns only directly-attached tags. When include_inherited=True, walks the ancestor chain and returns the deduplicated union of tags from all ancestors (including the path part itself).
|
|
505
|
+
* Get Path Part Tags Handler
|
|
506
|
+
*/
|
|
507
|
+
async getPathPartTagsRaw(requestParameters: GetPathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartTagsResponse>> {
|
|
508
|
+
const requestOptions = await this.getPathPartTagsRequestOpts(requestParameters);
|
|
509
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
510
|
+
|
|
511
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PathPartTagsResponseFromJSON(jsonValue));
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
/**
|
|
515
|
+
* Get tags for a path part. When include_inherited=False (default), returns only directly-attached tags. When include_inherited=True, walks the ancestor chain and returns the deduplicated union of tags from all ancestors (including the path part itself).
|
|
516
|
+
* Get Path Part Tags Handler
|
|
517
|
+
*/
|
|
518
|
+
async getPathPartTags(requestParameters: GetPathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartTagsResponse> {
|
|
519
|
+
const response = await this.getPathPartTagsRaw(requestParameters, initOverrides);
|
|
520
|
+
return await response.value();
|
|
521
|
+
}
|
|
522
|
+
|
|
523
|
+
/**
|
|
524
|
+
* Creates request options for listPathParts without sending the request
|
|
525
|
+
*/
|
|
526
|
+
async listPathPartsRequestOpts(requestParameters: ListPathPartsRequest): Promise<runtime.RequestOpts> {
|
|
296
527
|
const queryParameters: any = {};
|
|
297
528
|
|
|
298
529
|
if (requestParameters['parentPathId'] != null) {
|
|
@@ -320,12 +551,21 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
|
|
|
320
551
|
|
|
321
552
|
let urlPath = `/v1/path-parts`;
|
|
322
553
|
|
|
323
|
-
|
|
554
|
+
return {
|
|
324
555
|
path: urlPath,
|
|
325
556
|
method: 'GET',
|
|
326
557
|
headers: headerParameters,
|
|
327
558
|
query: queryParameters,
|
|
328
|
-
}
|
|
559
|
+
};
|
|
560
|
+
}
|
|
561
|
+
|
|
562
|
+
/**
|
|
563
|
+
* 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_path_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.
|
|
564
|
+
* List Path Parts Handler
|
|
565
|
+
*/
|
|
566
|
+
async listPathPartsRaw(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePathPartResponse>> {
|
|
567
|
+
const requestOptions = await this.listPathPartsRequestOpts(requestParameters);
|
|
568
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
329
569
|
|
|
330
570
|
return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponsePathPartResponseFromJSON(jsonValue));
|
|
331
571
|
}
|
package/src/apis/SectionsApi.ts
CHANGED
|
@@ -59,6 +59,15 @@ export interface UpdateSectionOperationRequest {
|
|
|
59
59
|
* @interface SectionsApiInterface
|
|
60
60
|
*/
|
|
61
61
|
export interface SectionsApiInterface {
|
|
62
|
+
/**
|
|
63
|
+
* Creates request options for createSection without sending the request
|
|
64
|
+
* @param {CreateSectionRequest} createSectionRequest
|
|
65
|
+
* @param {string} [ksUat]
|
|
66
|
+
* @throws {RequiredError}
|
|
67
|
+
* @memberof SectionsApiInterface
|
|
68
|
+
*/
|
|
69
|
+
createSectionRequestOpts(requestParameters: CreateSectionOperationRequest): Promise<runtime.RequestOpts>;
|
|
70
|
+
|
|
62
71
|
/**
|
|
63
72
|
* Create a new section. The section is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). If prev_sibling_path_id is provided, the section is inserted after that sibling; otherwise it is appended to the end of the sibling list.
|
|
64
73
|
* @summary Create Section Handler
|
|
@@ -76,6 +85,15 @@ export interface SectionsApiInterface {
|
|
|
76
85
|
*/
|
|
77
86
|
createSection(requestParameters: CreateSectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SectionResponse>;
|
|
78
87
|
|
|
88
|
+
/**
|
|
89
|
+
* Creates request options for deleteSection without sending the request
|
|
90
|
+
* @param {string} sectionId
|
|
91
|
+
* @param {string} [ksUat]
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
* @memberof SectionsApiInterface
|
|
94
|
+
*/
|
|
95
|
+
deleteSectionRequestOpts(requestParameters: DeleteSectionRequest): Promise<runtime.RequestOpts>;
|
|
96
|
+
|
|
79
97
|
/**
|
|
80
98
|
* Delete a section and all its children. WARNING: This cascades to all child sections due to parent_id ON DELETE CASCADE.
|
|
81
99
|
* @summary Delete Section Handler
|
|
@@ -93,6 +111,15 @@ export interface SectionsApiInterface {
|
|
|
93
111
|
*/
|
|
94
112
|
deleteSection(requestParameters: DeleteSectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
95
113
|
|
|
114
|
+
/**
|
|
115
|
+
* Creates request options for getSection without sending the request
|
|
116
|
+
* @param {string} sectionId
|
|
117
|
+
* @param {string} [ksUat]
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
* @memberof SectionsApiInterface
|
|
120
|
+
*/
|
|
121
|
+
getSectionRequestOpts(requestParameters: GetSectionRequest): Promise<runtime.RequestOpts>;
|
|
122
|
+
|
|
96
123
|
/**
|
|
97
124
|
* Get a section by its ID.
|
|
98
125
|
* @summary Get Section Handler
|
|
@@ -110,6 +137,16 @@ export interface SectionsApiInterface {
|
|
|
110
137
|
*/
|
|
111
138
|
getSection(requestParameters: GetSectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SectionResponse>;
|
|
112
139
|
|
|
140
|
+
/**
|
|
141
|
+
* Creates request options for updateSection without sending the request
|
|
142
|
+
* @param {string} sectionId
|
|
143
|
+
* @param {UpdateSectionRequest} updateSectionRequest
|
|
144
|
+
* @param {string} [ksUat]
|
|
145
|
+
* @throws {RequiredError}
|
|
146
|
+
* @memberof SectionsApiInterface
|
|
147
|
+
*/
|
|
148
|
+
updateSectionRequestOpts(requestParameters: UpdateSectionOperationRequest): Promise<runtime.RequestOpts>;
|
|
149
|
+
|
|
113
150
|
/**
|
|
114
151
|
* Update a section. Can update name, page_number, and/or reorder within siblings. To move: provide prev_sibling_path_id OR move_to_head (not both). Moving is only allowed within the same document version. Note: Section names can contain any characters. The corresponding path_part.name will be automatically normalized by a database trigger.
|
|
115
152
|
* @summary Update Section Handler
|
|
@@ -136,10 +173,9 @@ export interface SectionsApiInterface {
|
|
|
136
173
|
export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface {
|
|
137
174
|
|
|
138
175
|
/**
|
|
139
|
-
*
|
|
140
|
-
* Create Section Handler
|
|
176
|
+
* Creates request options for createSection without sending the request
|
|
141
177
|
*/
|
|
142
|
-
async
|
|
178
|
+
async createSectionRequestOpts(requestParameters: CreateSectionOperationRequest): Promise<runtime.RequestOpts> {
|
|
143
179
|
if (requestParameters['createSectionRequest'] == null) {
|
|
144
180
|
throw new runtime.RequiredError(
|
|
145
181
|
'createSectionRequest',
|
|
@@ -156,13 +192,22 @@ export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface
|
|
|
156
192
|
|
|
157
193
|
let urlPath = `/v1/sections`;
|
|
158
194
|
|
|
159
|
-
|
|
195
|
+
return {
|
|
160
196
|
path: urlPath,
|
|
161
197
|
method: 'POST',
|
|
162
198
|
headers: headerParameters,
|
|
163
199
|
query: queryParameters,
|
|
164
200
|
body: CreateSectionRequestToJSON(requestParameters['createSectionRequest']),
|
|
165
|
-
}
|
|
201
|
+
};
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* Create a new section. The section is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). If prev_sibling_path_id is provided, the section is inserted after that sibling; otherwise it is appended to the end of the sibling list.
|
|
206
|
+
* Create Section Handler
|
|
207
|
+
*/
|
|
208
|
+
async createSectionRaw(requestParameters: CreateSectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SectionResponse>> {
|
|
209
|
+
const requestOptions = await this.createSectionRequestOpts(requestParameters);
|
|
210
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
166
211
|
|
|
167
212
|
return new runtime.JSONApiResponse(response, (jsonValue) => SectionResponseFromJSON(jsonValue));
|
|
168
213
|
}
|
|
@@ -177,10 +222,9 @@ export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface
|
|
|
177
222
|
}
|
|
178
223
|
|
|
179
224
|
/**
|
|
180
|
-
*
|
|
181
|
-
* Delete Section Handler
|
|
225
|
+
* Creates request options for deleteSection without sending the request
|
|
182
226
|
*/
|
|
183
|
-
async
|
|
227
|
+
async deleteSectionRequestOpts(requestParameters: DeleteSectionRequest): Promise<runtime.RequestOpts> {
|
|
184
228
|
if (requestParameters['sectionId'] == null) {
|
|
185
229
|
throw new runtime.RequiredError(
|
|
186
230
|
'sectionId',
|
|
@@ -196,12 +240,21 @@ export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface
|
|
|
196
240
|
let urlPath = `/v1/sections/{section_id}`;
|
|
197
241
|
urlPath = urlPath.replace(`{${"section_id"}}`, encodeURIComponent(String(requestParameters['sectionId'])));
|
|
198
242
|
|
|
199
|
-
|
|
243
|
+
return {
|
|
200
244
|
path: urlPath,
|
|
201
245
|
method: 'DELETE',
|
|
202
246
|
headers: headerParameters,
|
|
203
247
|
query: queryParameters,
|
|
204
|
-
}
|
|
248
|
+
};
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
/**
|
|
252
|
+
* Delete a section and all its children. WARNING: This cascades to all child sections due to parent_id ON DELETE CASCADE.
|
|
253
|
+
* Delete Section Handler
|
|
254
|
+
*/
|
|
255
|
+
async deleteSectionRaw(requestParameters: DeleteSectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
256
|
+
const requestOptions = await this.deleteSectionRequestOpts(requestParameters);
|
|
257
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
205
258
|
|
|
206
259
|
return new runtime.VoidApiResponse(response);
|
|
207
260
|
}
|
|
@@ -215,10 +268,9 @@ export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface
|
|
|
215
268
|
}
|
|
216
269
|
|
|
217
270
|
/**
|
|
218
|
-
*
|
|
219
|
-
* Get Section Handler
|
|
271
|
+
* Creates request options for getSection without sending the request
|
|
220
272
|
*/
|
|
221
|
-
async
|
|
273
|
+
async getSectionRequestOpts(requestParameters: GetSectionRequest): Promise<runtime.RequestOpts> {
|
|
222
274
|
if (requestParameters['sectionId'] == null) {
|
|
223
275
|
throw new runtime.RequiredError(
|
|
224
276
|
'sectionId',
|
|
@@ -234,12 +286,21 @@ export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface
|
|
|
234
286
|
let urlPath = `/v1/sections/{section_id}`;
|
|
235
287
|
urlPath = urlPath.replace(`{${"section_id"}}`, encodeURIComponent(String(requestParameters['sectionId'])));
|
|
236
288
|
|
|
237
|
-
|
|
289
|
+
return {
|
|
238
290
|
path: urlPath,
|
|
239
291
|
method: 'GET',
|
|
240
292
|
headers: headerParameters,
|
|
241
293
|
query: queryParameters,
|
|
242
|
-
}
|
|
294
|
+
};
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* Get a section by its ID.
|
|
299
|
+
* Get Section Handler
|
|
300
|
+
*/
|
|
301
|
+
async getSectionRaw(requestParameters: GetSectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SectionResponse>> {
|
|
302
|
+
const requestOptions = await this.getSectionRequestOpts(requestParameters);
|
|
303
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
243
304
|
|
|
244
305
|
return new runtime.JSONApiResponse(response, (jsonValue) => SectionResponseFromJSON(jsonValue));
|
|
245
306
|
}
|
|
@@ -254,10 +315,9 @@ export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface
|
|
|
254
315
|
}
|
|
255
316
|
|
|
256
317
|
/**
|
|
257
|
-
*
|
|
258
|
-
* Update Section Handler
|
|
318
|
+
* Creates request options for updateSection without sending the request
|
|
259
319
|
*/
|
|
260
|
-
async
|
|
320
|
+
async updateSectionRequestOpts(requestParameters: UpdateSectionOperationRequest): Promise<runtime.RequestOpts> {
|
|
261
321
|
if (requestParameters['sectionId'] == null) {
|
|
262
322
|
throw new runtime.RequiredError(
|
|
263
323
|
'sectionId',
|
|
@@ -282,13 +342,22 @@ export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface
|
|
|
282
342
|
let urlPath = `/v1/sections/{section_id}`;
|
|
283
343
|
urlPath = urlPath.replace(`{${"section_id"}}`, encodeURIComponent(String(requestParameters['sectionId'])));
|
|
284
344
|
|
|
285
|
-
|
|
345
|
+
return {
|
|
286
346
|
path: urlPath,
|
|
287
347
|
method: 'PATCH',
|
|
288
348
|
headers: headerParameters,
|
|
289
349
|
query: queryParameters,
|
|
290
350
|
body: UpdateSectionRequestToJSON(requestParameters['updateSectionRequest']),
|
|
291
|
-
}
|
|
351
|
+
};
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
/**
|
|
355
|
+
* Update a section. Can update name, page_number, and/or reorder within siblings. To move: provide prev_sibling_path_id OR move_to_head (not both). Moving is only allowed within the same document version. Note: Section names can contain any characters. The corresponding path_part.name will be automatically normalized by a database trigger.
|
|
356
|
+
* Update Section Handler
|
|
357
|
+
*/
|
|
358
|
+
async updateSectionRaw(requestParameters: UpdateSectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SectionResponse>> {
|
|
359
|
+
const requestOptions = await this.updateSectionRequestOpts(requestParameters);
|
|
360
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
292
361
|
|
|
293
362
|
return new runtime.JSONApiResponse(response, (jsonValue) => SectionResponseFromJSON(jsonValue));
|
|
294
363
|
}
|