@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/FoldersApi.ts
CHANGED
|
@@ -18,7 +18,7 @@ import type {
|
|
|
18
18
|
CreateFolderRequest,
|
|
19
19
|
FolderResponse,
|
|
20
20
|
HTTPValidationError,
|
|
21
|
-
|
|
21
|
+
PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator,
|
|
22
22
|
PaginatedResponseFolderResponse,
|
|
23
23
|
PathOrder,
|
|
24
24
|
UpdateFolderRequest,
|
|
@@ -30,8 +30,8 @@ import {
|
|
|
30
30
|
FolderResponseToJSON,
|
|
31
31
|
HTTPValidationErrorFromJSON,
|
|
32
32
|
HTTPValidationErrorToJSON,
|
|
33
|
-
|
|
34
|
-
|
|
33
|
+
PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminatorFromJSON,
|
|
34
|
+
PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminatorToJSON,
|
|
35
35
|
PaginatedResponseFolderResponseFromJSON,
|
|
36
36
|
PaginatedResponseFolderResponseToJSON,
|
|
37
37
|
PathOrderFromJSON,
|
|
@@ -88,6 +88,15 @@ export interface UpdateFolderOperationRequest {
|
|
|
88
88
|
* @interface FoldersApiInterface
|
|
89
89
|
*/
|
|
90
90
|
export interface FoldersApiInterface {
|
|
91
|
+
/**
|
|
92
|
+
* Creates request options for createFolder without sending the request
|
|
93
|
+
* @param {CreateFolderRequest} createFolderRequest
|
|
94
|
+
* @param {string} [ksUat]
|
|
95
|
+
* @throws {RequiredError}
|
|
96
|
+
* @memberof FoldersApiInterface
|
|
97
|
+
*/
|
|
98
|
+
createFolderRequestOpts(requestParameters: CreateFolderOperationRequest): Promise<runtime.RequestOpts>;
|
|
99
|
+
|
|
91
100
|
/**
|
|
92
101
|
* 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.
|
|
93
102
|
* @summary Create Folder Handler
|
|
@@ -105,6 +114,15 @@ export interface FoldersApiInterface {
|
|
|
105
114
|
*/
|
|
106
115
|
createFolder(requestParameters: CreateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
|
|
107
116
|
|
|
117
|
+
/**
|
|
118
|
+
* Creates request options for deleteFolder without sending the request
|
|
119
|
+
* @param {string} folderId
|
|
120
|
+
* @param {string} [ksUat]
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
* @memberof FoldersApiInterface
|
|
123
|
+
*/
|
|
124
|
+
deleteFolderRequestOpts(requestParameters: DeleteFolderRequest): Promise<runtime.RequestOpts>;
|
|
125
|
+
|
|
108
126
|
/**
|
|
109
127
|
* 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.
|
|
110
128
|
* @summary Delete Folder Handler
|
|
@@ -122,6 +140,16 @@ export interface FoldersApiInterface {
|
|
|
122
140
|
*/
|
|
123
141
|
deleteFolder(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
124
142
|
|
|
143
|
+
/**
|
|
144
|
+
* Creates request options for getFolder without sending the request
|
|
145
|
+
* @param {string} folderId
|
|
146
|
+
* @param {boolean} [withTags] Include tags in the response (default: false)
|
|
147
|
+
* @param {string} [ksUat]
|
|
148
|
+
* @throws {RequiredError}
|
|
149
|
+
* @memberof FoldersApiInterface
|
|
150
|
+
*/
|
|
151
|
+
getFolderRequestOpts(requestParameters: GetFolderRequest): Promise<runtime.RequestOpts>;
|
|
152
|
+
|
|
125
153
|
/**
|
|
126
154
|
* Get a folder by its folder ID.
|
|
127
155
|
* @summary Get Folder Handler
|
|
@@ -141,7 +169,21 @@ export interface FoldersApiInterface {
|
|
|
141
169
|
getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
|
|
142
170
|
|
|
143
171
|
/**
|
|
144
|
-
*
|
|
172
|
+
* Creates request options for listFolderContents without sending the request
|
|
173
|
+
* @param {string} folderId
|
|
174
|
+
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
175
|
+
* @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
176
|
+
* @param {boolean} [withTags] Include tag IDs for each item (default: false)
|
|
177
|
+
* @param {number} [limit] Number of items per page
|
|
178
|
+
* @param {number} [offset] Number of items to skip
|
|
179
|
+
* @param {string} [ksUat]
|
|
180
|
+
* @throws {RequiredError}
|
|
181
|
+
* @memberof FoldersApiInterface
|
|
182
|
+
*/
|
|
183
|
+
listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
|
|
184
|
+
|
|
185
|
+
/**
|
|
186
|
+
* 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.
|
|
145
187
|
* @summary List Folder Contents Handler
|
|
146
188
|
* @param {string} folderId
|
|
147
189
|
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
@@ -154,13 +196,26 @@ export interface FoldersApiInterface {
|
|
|
154
196
|
* @throws {RequiredError}
|
|
155
197
|
* @memberof FoldersApiInterface
|
|
156
198
|
*/
|
|
157
|
-
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
199
|
+
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>>;
|
|
158
200
|
|
|
159
201
|
/**
|
|
160
|
-
* List all contents (folders and documents) under a folder. Returns
|
|
202
|
+
* 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.
|
|
161
203
|
* List Folder Contents Handler
|
|
162
204
|
*/
|
|
163
|
-
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
205
|
+
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>;
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* Creates request options for listFolders without sending the request
|
|
209
|
+
* @param {string} [parentPathPartId] Parent PathPart ID (defaults to root)
|
|
210
|
+
* @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
211
|
+
* @param {boolean} [withTags] Include tags in the response (default: false)
|
|
212
|
+
* @param {number} [limit] Number of items per page
|
|
213
|
+
* @param {number} [offset] Number of items to skip
|
|
214
|
+
* @param {string} [ksUat]
|
|
215
|
+
* @throws {RequiredError}
|
|
216
|
+
* @memberof FoldersApiInterface
|
|
217
|
+
*/
|
|
218
|
+
listFoldersRequestOpts(requestParameters: ListFoldersRequest): Promise<runtime.RequestOpts>;
|
|
164
219
|
|
|
165
220
|
/**
|
|
166
221
|
* 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\".
|
|
@@ -183,6 +238,16 @@ export interface FoldersApiInterface {
|
|
|
183
238
|
*/
|
|
184
239
|
listFolders(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
|
|
185
240
|
|
|
241
|
+
/**
|
|
242
|
+
* Creates request options for updateFolder without sending the request
|
|
243
|
+
* @param {string} folderId
|
|
244
|
+
* @param {UpdateFolderRequest} updateFolderRequest
|
|
245
|
+
* @param {string} [ksUat]
|
|
246
|
+
* @throws {RequiredError}
|
|
247
|
+
* @memberof FoldersApiInterface
|
|
248
|
+
*/
|
|
249
|
+
updateFolderRequestOpts(requestParameters: UpdateFolderOperationRequest): Promise<runtime.RequestOpts>;
|
|
250
|
+
|
|
186
251
|
/**
|
|
187
252
|
* 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.
|
|
188
253
|
* @summary Update Folder Handler
|
|
@@ -209,10 +274,9 @@ export interface FoldersApiInterface {
|
|
|
209
274
|
export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
210
275
|
|
|
211
276
|
/**
|
|
212
|
-
*
|
|
213
|
-
* Create Folder Handler
|
|
277
|
+
* Creates request options for createFolder without sending the request
|
|
214
278
|
*/
|
|
215
|
-
async
|
|
279
|
+
async createFolderRequestOpts(requestParameters: CreateFolderOperationRequest): Promise<runtime.RequestOpts> {
|
|
216
280
|
if (requestParameters['createFolderRequest'] == null) {
|
|
217
281
|
throw new runtime.RequiredError(
|
|
218
282
|
'createFolderRequest',
|
|
@@ -229,13 +293,22 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
229
293
|
|
|
230
294
|
let urlPath = `/v1/folders`;
|
|
231
295
|
|
|
232
|
-
|
|
296
|
+
return {
|
|
233
297
|
path: urlPath,
|
|
234
298
|
method: 'POST',
|
|
235
299
|
headers: headerParameters,
|
|
236
300
|
query: queryParameters,
|
|
237
301
|
body: CreateFolderRequestToJSON(requestParameters['createFolderRequest']),
|
|
238
|
-
}
|
|
302
|
+
};
|
|
303
|
+
}
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* 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.
|
|
307
|
+
* Create Folder Handler
|
|
308
|
+
*/
|
|
309
|
+
async createFolderRaw(requestParameters: CreateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>> {
|
|
310
|
+
const requestOptions = await this.createFolderRequestOpts(requestParameters);
|
|
311
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
239
312
|
|
|
240
313
|
return new runtime.JSONApiResponse(response, (jsonValue) => FolderResponseFromJSON(jsonValue));
|
|
241
314
|
}
|
|
@@ -250,10 +323,9 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
250
323
|
}
|
|
251
324
|
|
|
252
325
|
/**
|
|
253
|
-
*
|
|
254
|
-
* Delete Folder Handler
|
|
326
|
+
* Creates request options for deleteFolder without sending the request
|
|
255
327
|
*/
|
|
256
|
-
async
|
|
328
|
+
async deleteFolderRequestOpts(requestParameters: DeleteFolderRequest): Promise<runtime.RequestOpts> {
|
|
257
329
|
if (requestParameters['folderId'] == null) {
|
|
258
330
|
throw new runtime.RequiredError(
|
|
259
331
|
'folderId',
|
|
@@ -269,12 +341,21 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
269
341
|
let urlPath = `/v1/folders/{folder_id}`;
|
|
270
342
|
urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
|
|
271
343
|
|
|
272
|
-
|
|
344
|
+
return {
|
|
273
345
|
path: urlPath,
|
|
274
346
|
method: 'DELETE',
|
|
275
347
|
headers: headerParameters,
|
|
276
348
|
query: queryParameters,
|
|
277
|
-
}
|
|
349
|
+
};
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
/**
|
|
353
|
+
* 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.
|
|
354
|
+
* Delete Folder Handler
|
|
355
|
+
*/
|
|
356
|
+
async deleteFolderRaw(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
357
|
+
const requestOptions = await this.deleteFolderRequestOpts(requestParameters);
|
|
358
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
278
359
|
|
|
279
360
|
return new runtime.VoidApiResponse(response);
|
|
280
361
|
}
|
|
@@ -288,10 +369,9 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
288
369
|
}
|
|
289
370
|
|
|
290
371
|
/**
|
|
291
|
-
*
|
|
292
|
-
* Get Folder Handler
|
|
372
|
+
* Creates request options for getFolder without sending the request
|
|
293
373
|
*/
|
|
294
|
-
async
|
|
374
|
+
async getFolderRequestOpts(requestParameters: GetFolderRequest): Promise<runtime.RequestOpts> {
|
|
295
375
|
if (requestParameters['folderId'] == null) {
|
|
296
376
|
throw new runtime.RequiredError(
|
|
297
377
|
'folderId',
|
|
@@ -311,12 +391,21 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
311
391
|
let urlPath = `/v1/folders/{folder_id}`;
|
|
312
392
|
urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
|
|
313
393
|
|
|
314
|
-
|
|
394
|
+
return {
|
|
315
395
|
path: urlPath,
|
|
316
396
|
method: 'GET',
|
|
317
397
|
headers: headerParameters,
|
|
318
398
|
query: queryParameters,
|
|
319
|
-
}
|
|
399
|
+
};
|
|
400
|
+
}
|
|
401
|
+
|
|
402
|
+
/**
|
|
403
|
+
* Get a folder by its folder ID.
|
|
404
|
+
* Get Folder Handler
|
|
405
|
+
*/
|
|
406
|
+
async getFolderRaw(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>> {
|
|
407
|
+
const requestOptions = await this.getFolderRequestOpts(requestParameters);
|
|
408
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
320
409
|
|
|
321
410
|
return new runtime.JSONApiResponse(response, (jsonValue) => FolderResponseFromJSON(jsonValue));
|
|
322
411
|
}
|
|
@@ -331,10 +420,9 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
331
420
|
}
|
|
332
421
|
|
|
333
422
|
/**
|
|
334
|
-
*
|
|
335
|
-
* List Folder Contents Handler
|
|
423
|
+
* Creates request options for listFolderContents without sending the request
|
|
336
424
|
*/
|
|
337
|
-
async
|
|
425
|
+
async listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts> {
|
|
338
426
|
if (requestParameters['folderId'] == null) {
|
|
339
427
|
throw new runtime.RequiredError(
|
|
340
428
|
'folderId',
|
|
@@ -370,30 +458,38 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
370
458
|
let urlPath = `/v1/folders/{folder_id}/contents`;
|
|
371
459
|
urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
|
|
372
460
|
|
|
373
|
-
|
|
461
|
+
return {
|
|
374
462
|
path: urlPath,
|
|
375
463
|
method: 'GET',
|
|
376
464
|
headers: headerParameters,
|
|
377
465
|
query: queryParameters,
|
|
378
|
-
}
|
|
466
|
+
};
|
|
467
|
+
}
|
|
468
|
+
|
|
469
|
+
/**
|
|
470
|
+
* 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.
|
|
471
|
+
* List Folder Contents Handler
|
|
472
|
+
*/
|
|
473
|
+
async listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>> {
|
|
474
|
+
const requestOptions = await this.listFolderContentsRequestOpts(requestParameters);
|
|
475
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
379
476
|
|
|
380
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
477
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminatorFromJSON(jsonValue));
|
|
381
478
|
}
|
|
382
479
|
|
|
383
480
|
/**
|
|
384
|
-
* List all contents (folders and documents) under a folder. Returns
|
|
481
|
+
* 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.
|
|
385
482
|
* List Folder Contents Handler
|
|
386
483
|
*/
|
|
387
|
-
async listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
484
|
+
async listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator> {
|
|
388
485
|
const response = await this.listFolderContentsRaw(requestParameters, initOverrides);
|
|
389
486
|
return await response.value();
|
|
390
487
|
}
|
|
391
488
|
|
|
392
489
|
/**
|
|
393
|
-
*
|
|
394
|
-
* List Folders Handler
|
|
490
|
+
* Creates request options for listFolders without sending the request
|
|
395
491
|
*/
|
|
396
|
-
async
|
|
492
|
+
async listFoldersRequestOpts(requestParameters: ListFoldersRequest): Promise<runtime.RequestOpts> {
|
|
397
493
|
const queryParameters: any = {};
|
|
398
494
|
|
|
399
495
|
if (requestParameters['parentPathPartId'] != null) {
|
|
@@ -421,12 +517,21 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
421
517
|
|
|
422
518
|
let urlPath = `/v1/folders`;
|
|
423
519
|
|
|
424
|
-
|
|
520
|
+
return {
|
|
425
521
|
path: urlPath,
|
|
426
522
|
method: 'GET',
|
|
427
523
|
headers: headerParameters,
|
|
428
524
|
query: queryParameters,
|
|
429
|
-
}
|
|
525
|
+
};
|
|
526
|
+
}
|
|
527
|
+
|
|
528
|
+
/**
|
|
529
|
+
* 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\".
|
|
530
|
+
* List Folders Handler
|
|
531
|
+
*/
|
|
532
|
+
async listFoldersRaw(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderResponse>> {
|
|
533
|
+
const requestOptions = await this.listFoldersRequestOpts(requestParameters);
|
|
534
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
430
535
|
|
|
431
536
|
return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseFolderResponseFromJSON(jsonValue));
|
|
432
537
|
}
|
|
@@ -441,10 +546,9 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
441
546
|
}
|
|
442
547
|
|
|
443
548
|
/**
|
|
444
|
-
*
|
|
445
|
-
* Update Folder Handler
|
|
549
|
+
* Creates request options for updateFolder without sending the request
|
|
446
550
|
*/
|
|
447
|
-
async
|
|
551
|
+
async updateFolderRequestOpts(requestParameters: UpdateFolderOperationRequest): Promise<runtime.RequestOpts> {
|
|
448
552
|
if (requestParameters['folderId'] == null) {
|
|
449
553
|
throw new runtime.RequiredError(
|
|
450
554
|
'folderId',
|
|
@@ -469,13 +573,22 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
469
573
|
let urlPath = `/v1/folders/{folder_id}`;
|
|
470
574
|
urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
|
|
471
575
|
|
|
472
|
-
|
|
576
|
+
return {
|
|
473
577
|
path: urlPath,
|
|
474
578
|
method: 'PATCH',
|
|
475
579
|
headers: headerParameters,
|
|
476
580
|
query: queryParameters,
|
|
477
581
|
body: UpdateFolderRequestToJSON(requestParameters['updateFolderRequest']),
|
|
478
|
-
}
|
|
582
|
+
};
|
|
583
|
+
}
|
|
584
|
+
|
|
585
|
+
/**
|
|
586
|
+
* 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.
|
|
587
|
+
* Update Folder Handler
|
|
588
|
+
*/
|
|
589
|
+
async updateFolderRaw(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>> {
|
|
590
|
+
const requestOptions = await this.updateFolderRequestOpts(requestParameters);
|
|
591
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
479
592
|
|
|
480
593
|
return new runtime.JSONApiResponse(response, (jsonValue) => FolderResponseFromJSON(jsonValue));
|
|
481
594
|
}
|
package/src/apis/InvitesApi.ts
CHANGED
|
@@ -64,6 +64,15 @@ export interface ListInvitesRequest {
|
|
|
64
64
|
* @interface InvitesApiInterface
|
|
65
65
|
*/
|
|
66
66
|
export interface InvitesApiInterface {
|
|
67
|
+
/**
|
|
68
|
+
* Creates request options for acceptInvite without sending the request
|
|
69
|
+
* @param {string} inviteId
|
|
70
|
+
* @param {string} [ksUat]
|
|
71
|
+
* @throws {RequiredError}
|
|
72
|
+
* @memberof InvitesApiInterface
|
|
73
|
+
*/
|
|
74
|
+
acceptInviteRequestOpts(requestParameters: AcceptInviteRequest): Promise<runtime.RequestOpts>;
|
|
75
|
+
|
|
67
76
|
/**
|
|
68
77
|
* Update an invite to accepted status and create tenant user.
|
|
69
78
|
* @summary Accept Invite
|
|
@@ -81,6 +90,15 @@ export interface InvitesApiInterface {
|
|
|
81
90
|
*/
|
|
82
91
|
acceptInvite(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
|
|
83
92
|
|
|
93
|
+
/**
|
|
94
|
+
* Creates request options for createInvite without sending the request
|
|
95
|
+
* @param {InviteUserRequest} inviteUserRequest
|
|
96
|
+
* @param {string} [ksUat]
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
* @memberof InvitesApiInterface
|
|
99
|
+
*/
|
|
100
|
+
createInviteRequestOpts(requestParameters: CreateInviteRequest): Promise<runtime.RequestOpts>;
|
|
101
|
+
|
|
84
102
|
/**
|
|
85
103
|
* Create an invite for a user to join a tenant (admin-only). For external IdP tenants (idp_config is set), users are added directly if they exist. For shared IdP tenants (PASSWORD/GOOGLE), an email invite is sent that must be accepted.
|
|
86
104
|
* @summary Create Invite
|
|
@@ -98,6 +116,15 @@ export interface InvitesApiInterface {
|
|
|
98
116
|
*/
|
|
99
117
|
createInvite(requestParameters: CreateInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InviteResponse>;
|
|
100
118
|
|
|
119
|
+
/**
|
|
120
|
+
* Creates request options for deleteInvite without sending the request
|
|
121
|
+
* @param {string} inviteId
|
|
122
|
+
* @param {string} [ksUat]
|
|
123
|
+
* @throws {RequiredError}
|
|
124
|
+
* @memberof InvitesApiInterface
|
|
125
|
+
*/
|
|
126
|
+
deleteInviteRequestOpts(requestParameters: DeleteInviteRequest): Promise<runtime.RequestOpts>;
|
|
127
|
+
|
|
101
128
|
/**
|
|
102
129
|
* Hard-delete an invite (admin/owner only). Permanently removes the invite. The invite must belong to the caller\'s current tenant.
|
|
103
130
|
* @summary Delete Invite
|
|
@@ -115,6 +142,18 @@ export interface InvitesApiInterface {
|
|
|
115
142
|
*/
|
|
116
143
|
deleteInvite(requestParameters: DeleteInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
117
144
|
|
|
145
|
+
/**
|
|
146
|
+
* Creates request options for listInvites without sending the request
|
|
147
|
+
* @param {string} [email] Filter by email (case-insensitive partial match)
|
|
148
|
+
* @param {InviteStatus} [status] Filter by invite status (pending, accepted, expired)
|
|
149
|
+
* @param {number} [limit] Number of items per page
|
|
150
|
+
* @param {number} [offset] Number of items to skip
|
|
151
|
+
* @param {string} [ksUat]
|
|
152
|
+
* @throws {RequiredError}
|
|
153
|
+
* @memberof InvitesApiInterface
|
|
154
|
+
*/
|
|
155
|
+
listInvitesRequestOpts(requestParameters: ListInvitesRequest): Promise<runtime.RequestOpts>;
|
|
156
|
+
|
|
118
157
|
/**
|
|
119
158
|
* List invites with pagination, filtering, and sorting. Supports filtering by tenant_id (requires admin access), email, and status. Results can be sorted by created_at, updated_at, expires_at, or accepted_at.
|
|
120
159
|
* @summary List Invites Handler
|
|
@@ -143,10 +182,9 @@ export interface InvitesApiInterface {
|
|
|
143
182
|
export class InvitesApi extends runtime.BaseAPI implements InvitesApiInterface {
|
|
144
183
|
|
|
145
184
|
/**
|
|
146
|
-
*
|
|
147
|
-
* Accept Invite
|
|
185
|
+
* Creates request options for acceptInvite without sending the request
|
|
148
186
|
*/
|
|
149
|
-
async
|
|
187
|
+
async acceptInviteRequestOpts(requestParameters: AcceptInviteRequest): Promise<runtime.RequestOpts> {
|
|
150
188
|
if (requestParameters['inviteId'] == null) {
|
|
151
189
|
throw new runtime.RequiredError(
|
|
152
190
|
'inviteId',
|
|
@@ -162,12 +200,21 @@ export class InvitesApi extends runtime.BaseAPI implements InvitesApiInterface {
|
|
|
162
200
|
let urlPath = `/v1/invites/{invite_id}/accept`;
|
|
163
201
|
urlPath = urlPath.replace(`{${"invite_id"}}`, encodeURIComponent(String(requestParameters['inviteId'])));
|
|
164
202
|
|
|
165
|
-
|
|
203
|
+
return {
|
|
166
204
|
path: urlPath,
|
|
167
205
|
method: 'POST',
|
|
168
206
|
headers: headerParameters,
|
|
169
207
|
query: queryParameters,
|
|
170
|
-
}
|
|
208
|
+
};
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
/**
|
|
212
|
+
* Update an invite to accepted status and create tenant user.
|
|
213
|
+
* Accept Invite
|
|
214
|
+
*/
|
|
215
|
+
async acceptInviteRaw(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>> {
|
|
216
|
+
const requestOptions = await this.acceptInviteRequestOpts(requestParameters);
|
|
217
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
171
218
|
|
|
172
219
|
if (this.isJsonMime(response.headers.get('content-type'))) {
|
|
173
220
|
return new runtime.JSONApiResponse<any>(response);
|
|
@@ -186,10 +233,9 @@ export class InvitesApi extends runtime.BaseAPI implements InvitesApiInterface {
|
|
|
186
233
|
}
|
|
187
234
|
|
|
188
235
|
/**
|
|
189
|
-
*
|
|
190
|
-
* Create Invite
|
|
236
|
+
* Creates request options for createInvite without sending the request
|
|
191
237
|
*/
|
|
192
|
-
async
|
|
238
|
+
async createInviteRequestOpts(requestParameters: CreateInviteRequest): Promise<runtime.RequestOpts> {
|
|
193
239
|
if (requestParameters['inviteUserRequest'] == null) {
|
|
194
240
|
throw new runtime.RequiredError(
|
|
195
241
|
'inviteUserRequest',
|
|
@@ -206,13 +252,22 @@ export class InvitesApi extends runtime.BaseAPI implements InvitesApiInterface {
|
|
|
206
252
|
|
|
207
253
|
let urlPath = `/v1/invites`;
|
|
208
254
|
|
|
209
|
-
|
|
255
|
+
return {
|
|
210
256
|
path: urlPath,
|
|
211
257
|
method: 'POST',
|
|
212
258
|
headers: headerParameters,
|
|
213
259
|
query: queryParameters,
|
|
214
260
|
body: InviteUserRequestToJSON(requestParameters['inviteUserRequest']),
|
|
215
|
-
}
|
|
261
|
+
};
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* Create an invite for a user to join a tenant (admin-only). For external IdP tenants (idp_config is set), users are added directly if they exist. For shared IdP tenants (PASSWORD/GOOGLE), an email invite is sent that must be accepted.
|
|
266
|
+
* Create Invite
|
|
267
|
+
*/
|
|
268
|
+
async createInviteRaw(requestParameters: CreateInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InviteResponse>> {
|
|
269
|
+
const requestOptions = await this.createInviteRequestOpts(requestParameters);
|
|
270
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
216
271
|
|
|
217
272
|
return new runtime.JSONApiResponse(response, (jsonValue) => InviteResponseFromJSON(jsonValue));
|
|
218
273
|
}
|
|
@@ -227,10 +282,9 @@ export class InvitesApi extends runtime.BaseAPI implements InvitesApiInterface {
|
|
|
227
282
|
}
|
|
228
283
|
|
|
229
284
|
/**
|
|
230
|
-
*
|
|
231
|
-
* Delete Invite
|
|
285
|
+
* Creates request options for deleteInvite without sending the request
|
|
232
286
|
*/
|
|
233
|
-
async
|
|
287
|
+
async deleteInviteRequestOpts(requestParameters: DeleteInviteRequest): Promise<runtime.RequestOpts> {
|
|
234
288
|
if (requestParameters['inviteId'] == null) {
|
|
235
289
|
throw new runtime.RequiredError(
|
|
236
290
|
'inviteId',
|
|
@@ -246,12 +300,21 @@ export class InvitesApi extends runtime.BaseAPI implements InvitesApiInterface {
|
|
|
246
300
|
let urlPath = `/v1/invites/{invite_id}`;
|
|
247
301
|
urlPath = urlPath.replace(`{${"invite_id"}}`, encodeURIComponent(String(requestParameters['inviteId'])));
|
|
248
302
|
|
|
249
|
-
|
|
303
|
+
return {
|
|
250
304
|
path: urlPath,
|
|
251
305
|
method: 'DELETE',
|
|
252
306
|
headers: headerParameters,
|
|
253
307
|
query: queryParameters,
|
|
254
|
-
}
|
|
308
|
+
};
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* Hard-delete an invite (admin/owner only). Permanently removes the invite. The invite must belong to the caller\'s current tenant.
|
|
313
|
+
* Delete Invite
|
|
314
|
+
*/
|
|
315
|
+
async deleteInviteRaw(requestParameters: DeleteInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
316
|
+
const requestOptions = await this.deleteInviteRequestOpts(requestParameters);
|
|
317
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
255
318
|
|
|
256
319
|
return new runtime.VoidApiResponse(response);
|
|
257
320
|
}
|
|
@@ -265,10 +328,9 @@ export class InvitesApi extends runtime.BaseAPI implements InvitesApiInterface {
|
|
|
265
328
|
}
|
|
266
329
|
|
|
267
330
|
/**
|
|
268
|
-
*
|
|
269
|
-
* List Invites Handler
|
|
331
|
+
* Creates request options for listInvites without sending the request
|
|
270
332
|
*/
|
|
271
|
-
async
|
|
333
|
+
async listInvitesRequestOpts(requestParameters: ListInvitesRequest): Promise<runtime.RequestOpts> {
|
|
272
334
|
const queryParameters: any = {};
|
|
273
335
|
|
|
274
336
|
if (requestParameters['email'] != null) {
|
|
@@ -292,12 +354,21 @@ export class InvitesApi extends runtime.BaseAPI implements InvitesApiInterface {
|
|
|
292
354
|
|
|
293
355
|
let urlPath = `/v1/invites`;
|
|
294
356
|
|
|
295
|
-
|
|
357
|
+
return {
|
|
296
358
|
path: urlPath,
|
|
297
359
|
method: 'GET',
|
|
298
360
|
headers: headerParameters,
|
|
299
361
|
query: queryParameters,
|
|
300
|
-
}
|
|
362
|
+
};
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
/**
|
|
366
|
+
* List invites with pagination, filtering, and sorting. Supports filtering by tenant_id (requires admin access), email, and status. Results can be sorted by created_at, updated_at, expires_at, or accepted_at.
|
|
367
|
+
* List Invites Handler
|
|
368
|
+
*/
|
|
369
|
+
async listInvitesRaw(requestParameters: ListInvitesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseInviteResponse>> {
|
|
370
|
+
const requestOptions = await this.listInvitesRequestOpts(requestParameters);
|
|
371
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
301
372
|
|
|
302
373
|
return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseInviteResponseFromJSON(jsonValue));
|
|
303
374
|
}
|