@knowledge-stack/ksapi 1.95.3 → 1.96.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 +82 -4
- package/README.md +79 -10
- package/dist/apis/AgentApi.d.ts +0 -12
- package/dist/apis/AgentApi.js +12 -4
- package/dist/apis/ApiKeysApi.d.ts +6 -20
- package/dist/apis/ApiKeysApi.js +6 -6
- package/dist/apis/AuditEventsApi.d.ts +85 -0
- package/dist/apis/AuditEventsApi.js +134 -0
- package/dist/apis/AuthApi.d.ts +0 -24
- package/dist/apis/AuthApi.js +24 -8
- package/dist/apis/ChunkLineagesApi.d.ts +0 -18
- package/dist/apis/ChunkLineagesApi.js +18 -6
- package/dist/apis/ChunksApi.d.ts +0 -54
- package/dist/apis/ChunksApi.js +54 -18
- package/dist/apis/DataSourcesApi.d.ts +304 -0
- package/dist/apis/DataSourcesApi.js +421 -0
- package/dist/apis/DocumentCheckoutApi.d.ts +0 -18
- package/dist/apis/DocumentCheckoutApi.js +18 -6
- package/dist/apis/DocumentVersionsApi.d.ts +83 -49
- package/dist/apis/DocumentVersionsApi.js +150 -16
- package/dist/apis/DocumentsApi.d.ts +58 -47
- package/dist/apis/DocumentsApi.js +107 -16
- package/dist/apis/FeedbackApi.d.ts +0 -18
- package/dist/apis/FeedbackApi.js +18 -6
- package/dist/apis/FoldersApi.d.ts +13 -61
- package/dist/apis/FoldersApi.js +52 -20
- package/dist/apis/InvitesApi.d.ts +0 -30
- package/dist/apis/InvitesApi.js +30 -10
- package/dist/apis/MemoryApi.d.ts +207 -0
- package/dist/apis/MemoryApi.js +306 -0
- package/dist/apis/PathPartApprovalsApi.d.ts +0 -12
- package/dist/apis/PathPartApprovalsApi.js +12 -4
- package/dist/apis/PathPartsApi.d.ts +45 -55
- package/dist/apis/PathPartsApi.js +111 -18
- package/dist/apis/SectionsApi.d.ts +0 -36
- package/dist/apis/SectionsApi.js +36 -12
- package/dist/apis/SubscriptionsApi.d.ts +0 -12
- package/dist/apis/SubscriptionsApi.js +12 -4
- package/dist/apis/TagsApi.d.ts +0 -30
- package/dist/apis/TagsApi.js +30 -10
- package/dist/apis/TenantGroupsApi.d.ts +6 -86
- package/dist/apis/TenantGroupsApi.js +84 -32
- package/dist/apis/TenantsApi.d.ts +0 -72
- package/dist/apis/TenantsApi.js +72 -24
- package/dist/apis/ThreadMessagesApi.d.ts +0 -18
- package/dist/apis/ThreadMessagesApi.js +18 -6
- package/dist/apis/ThreadsApi.d.ts +0 -42
- package/dist/apis/ThreadsApi.js +42 -14
- package/dist/apis/TrashApi.d.ts +143 -0
- package/dist/apis/TrashApi.js +210 -0
- package/dist/apis/UserPermissionsApi.d.ts +0 -24
- package/dist/apis/UserPermissionsApi.js +24 -8
- package/dist/apis/UsersApi.d.ts +12 -46
- package/dist/apis/UsersApi.js +42 -22
- package/dist/apis/WorkflowDefinitionsApi.d.ts +0 -42
- package/dist/apis/WorkflowDefinitionsApi.js +42 -14
- package/dist/apis/WorkflowMemoryApi.d.ts +0 -30
- package/dist/apis/WorkflowMemoryApi.js +30 -10
- package/dist/apis/WorkflowRunsApi.d.ts +4 -58
- package/dist/apis/WorkflowRunsApi.js +56 -20
- package/dist/apis/WorkflowsApi.d.ts +0 -30
- package/dist/apis/WorkflowsApi.js +30 -10
- package/dist/apis/index.d.ts +4 -0
- package/dist/apis/index.js +4 -0
- package/dist/esm/apis/AgentApi.d.ts +0 -12
- package/dist/esm/apis/AgentApi.js +12 -4
- package/dist/esm/apis/ApiKeysApi.d.ts +6 -20
- package/dist/esm/apis/ApiKeysApi.js +6 -6
- package/dist/esm/apis/AuditEventsApi.d.ts +85 -0
- package/dist/esm/apis/AuditEventsApi.js +97 -0
- package/dist/esm/apis/AuthApi.d.ts +0 -24
- package/dist/esm/apis/AuthApi.js +24 -8
- package/dist/esm/apis/ChunkLineagesApi.d.ts +0 -18
- package/dist/esm/apis/ChunkLineagesApi.js +18 -6
- package/dist/esm/apis/ChunksApi.d.ts +0 -54
- package/dist/esm/apis/ChunksApi.js +54 -18
- package/dist/esm/apis/DataSourcesApi.d.ts +304 -0
- package/dist/esm/apis/DataSourcesApi.js +384 -0
- package/dist/esm/apis/DocumentCheckoutApi.d.ts +0 -18
- package/dist/esm/apis/DocumentCheckoutApi.js +18 -6
- package/dist/esm/apis/DocumentVersionsApi.d.ts +83 -49
- package/dist/esm/apis/DocumentVersionsApi.js +151 -17
- package/dist/esm/apis/DocumentsApi.d.ts +58 -47
- package/dist/esm/apis/DocumentsApi.js +108 -17
- package/dist/esm/apis/FeedbackApi.d.ts +0 -18
- package/dist/esm/apis/FeedbackApi.js +18 -6
- package/dist/esm/apis/FoldersApi.d.ts +13 -61
- package/dist/esm/apis/FoldersApi.js +53 -21
- package/dist/esm/apis/InvitesApi.d.ts +0 -30
- package/dist/esm/apis/InvitesApi.js +30 -10
- package/dist/esm/apis/MemoryApi.d.ts +207 -0
- package/dist/esm/apis/MemoryApi.js +269 -0
- package/dist/esm/apis/PathPartApprovalsApi.d.ts +0 -12
- package/dist/esm/apis/PathPartApprovalsApi.js +12 -4
- package/dist/esm/apis/PathPartsApi.d.ts +45 -55
- package/dist/esm/apis/PathPartsApi.js +112 -19
- package/dist/esm/apis/SectionsApi.d.ts +0 -36
- package/dist/esm/apis/SectionsApi.js +36 -12
- package/dist/esm/apis/SubscriptionsApi.d.ts +0 -12
- package/dist/esm/apis/SubscriptionsApi.js +12 -4
- package/dist/esm/apis/TagsApi.d.ts +0 -30
- package/dist/esm/apis/TagsApi.js +30 -10
- package/dist/esm/apis/TenantGroupsApi.d.ts +6 -86
- package/dist/esm/apis/TenantGroupsApi.js +84 -32
- package/dist/esm/apis/TenantsApi.d.ts +0 -72
- package/dist/esm/apis/TenantsApi.js +72 -24
- package/dist/esm/apis/ThreadMessagesApi.d.ts +0 -18
- package/dist/esm/apis/ThreadMessagesApi.js +18 -6
- package/dist/esm/apis/ThreadsApi.d.ts +0 -42
- package/dist/esm/apis/ThreadsApi.js +42 -14
- package/dist/esm/apis/TrashApi.d.ts +143 -0
- package/dist/esm/apis/TrashApi.js +173 -0
- package/dist/esm/apis/UserPermissionsApi.d.ts +0 -24
- package/dist/esm/apis/UserPermissionsApi.js +24 -8
- package/dist/esm/apis/UsersApi.d.ts +12 -46
- package/dist/esm/apis/UsersApi.js +42 -22
- package/dist/esm/apis/WorkflowDefinitionsApi.d.ts +0 -42
- package/dist/esm/apis/WorkflowDefinitionsApi.js +42 -14
- package/dist/esm/apis/WorkflowMemoryApi.d.ts +0 -30
- package/dist/esm/apis/WorkflowMemoryApi.js +30 -10
- package/dist/esm/apis/WorkflowRunsApi.d.ts +4 -58
- package/dist/esm/apis/WorkflowRunsApi.js +56 -20
- package/dist/esm/apis/WorkflowsApi.d.ts +0 -30
- package/dist/esm/apis/WorkflowsApi.js +30 -10
- package/dist/esm/apis/index.d.ts +4 -0
- package/dist/esm/apis/index.js +4 -0
- package/dist/esm/models/AccessCheckResponse.d.ts +59 -0
- package/dist/esm/models/AccessCheckResponse.js +50 -0
- package/dist/esm/models/CatalogColumnResponse.d.ts +59 -0
- package/dist/esm/models/CatalogColumnResponse.js +52 -0
- package/dist/esm/models/CatalogTableResponse.d.ts +54 -0
- package/dist/esm/models/CatalogTableResponse.js +49 -0
- package/dist/esm/models/CellChange.d.ts +72 -0
- package/dist/esm/models/CellChange.js +61 -0
- package/dist/esm/models/CellChangeType.d.ts +26 -0
- package/dist/esm/models/CellChangeType.js +44 -0
- package/dist/esm/models/CellDiff.d.ts +72 -0
- package/dist/esm/models/CellDiff.js +61 -0
- package/dist/esm/models/ColumnConfig.d.ts +71 -0
- package/dist/esm/models/ColumnConfig.js +52 -0
- package/dist/esm/models/ConnectionConfig.d.ts +71 -0
- package/dist/esm/models/ConnectionConfig.js +58 -0
- package/dist/esm/models/CreateDataSourceRequest.d.ts +67 -0
- package/dist/esm/models/CreateDataSourceRequest.js +62 -0
- package/dist/esm/models/CreateGroupPermissionRequest.d.ts +6 -0
- package/dist/esm/models/CreateGroupPermissionRequest.js +2 -0
- package/dist/esm/models/CreatePermissionRequest.d.ts +6 -0
- package/dist/esm/models/CreatePermissionRequest.js +2 -0
- package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
- package/dist/esm/models/CreateWorkflowDefinitionRequest.js +4 -0
- package/dist/esm/models/DataSourceCatalogResponse.d.ts +48 -0
- package/dist/esm/models/DataSourceCatalogResponse.js +45 -0
- package/dist/esm/models/DataSourceDetailResponse.d.ts +55 -0
- package/dist/esm/models/DataSourceDetailResponse.js +50 -0
- package/dist/esm/models/DataSourceEngine.d.ts +25 -0
- package/dist/esm/models/DataSourceEngine.js +43 -0
- package/dist/esm/models/DataSourceQueryRequest.d.ts +53 -0
- package/dist/esm/models/DataSourceQueryRequest.js +53 -0
- package/dist/esm/models/DataSourceQueryResponse.d.ts +71 -0
- package/dist/esm/models/DataSourceQueryResponse.js +60 -0
- package/dist/esm/models/DataSourceResponse.d.ts +119 -0
- package/dist/esm/models/DataSourceResponse.js +90 -0
- package/dist/esm/models/DataSourceTableResponse.d.ts +135 -0
- package/dist/esm/models/DataSourceTableResponse.js +101 -0
- package/dist/esm/models/DiffFormat.d.ts +25 -0
- package/dist/esm/models/DiffFormat.js +43 -0
- package/dist/esm/models/DiffRow.d.ts +90 -0
- package/dist/esm/models/DiffRow.js +58 -0
- package/dist/esm/models/DiffRowType.d.ts +27 -0
- package/dist/esm/models/DiffRowType.js +45 -0
- package/dist/esm/models/DiffSpan.d.ts +53 -0
- package/dist/esm/models/DiffSpan.js +48 -0
- package/dist/esm/models/DocumentDownloadResponse.d.ts +72 -0
- package/dist/esm/models/DocumentDownloadResponse.js +61 -0
- package/dist/esm/models/DocumentResponse.d.ts +4 -3
- package/dist/esm/models/DocumentResponse.js +3 -2
- package/dist/esm/models/DownloadArtifact.d.ts +25 -0
- package/dist/esm/models/DownloadArtifact.js +43 -0
- package/dist/esm/models/EventResponse.d.ts +7 -0
- package/dist/esm/models/EventResponse.js +3 -0
- package/dist/esm/models/FolderResponse.d.ts +4 -3
- package/dist/esm/models/FolderResponse.js +3 -2
- package/dist/esm/models/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.d.ts +39 -0
- package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.js} +16 -6
- package/dist/esm/models/GroupPermissionResponse.d.ts +6 -0
- package/dist/esm/models/GroupPermissionResponse.js +4 -0
- package/dist/esm/models/ItemPermissions.d.ts +73 -0
- package/dist/esm/models/ItemPermissions.js +56 -0
- package/dist/esm/models/MemoryBodyResponse.d.ts +60 -0
- package/dist/esm/models/MemoryBodyResponse.js +53 -0
- package/dist/esm/models/MemoryScope.d.ts +29 -0
- package/dist/esm/models/MemoryScope.js +47 -0
- package/dist/esm/models/ModelTableRequest.d.ts +66 -0
- package/dist/esm/models/ModelTableRequest.js +51 -0
- package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.d.ts +66 -0
- package/dist/esm/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.js} +12 -12
- package/dist/esm/models/PaginatedResponsePendingMemoryChunkResponse.d.ts +66 -0
- package/dist/esm/models/PaginatedResponsePendingMemoryChunkResponse.js +70 -0
- package/dist/esm/models/PaginatedResponseTrashItemResponse.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseTrashItemResponse.js +70 -0
- package/dist/esm/models/PartType.d.ts +2 -0
- package/dist/esm/models/PartType.js +3 -1
- package/dist/esm/models/PathPartResponse.d.ts +4 -9
- package/dist/esm/models/PathPartResponse.js +4 -7
- package/dist/esm/models/PendingMemoryChunkResponse.d.ts +91 -0
- package/dist/esm/models/PendingMemoryChunkResponse.js +74 -0
- package/dist/esm/models/PermissionCapability.d.ts +2 -1
- package/dist/esm/models/PermissionCapability.js +3 -2
- package/dist/esm/models/PermissionResponse.d.ts +6 -0
- package/dist/esm/models/PermissionResponse.js +4 -0
- package/dist/esm/models/ProposeMemoryChunkRequest.d.ts +79 -0
- package/dist/esm/models/ProposeMemoryChunkRequest.js +71 -0
- package/dist/esm/models/ProposedMemoryChunkResponse.d.ts +91 -0
- package/dist/esm/models/ProposedMemoryChunkResponse.js +74 -0
- package/dist/esm/models/ReferenceType.d.ts +2 -0
- package/dist/esm/models/ReferenceType.js +2 -0
- package/dist/esm/models/TextDiff.d.ts +72 -0
- package/dist/esm/models/TextDiff.js +61 -0
- package/dist/esm/models/TrashItemResponse.d.ts +90 -0
- package/dist/esm/models/TrashItemResponse.js +73 -0
- package/dist/esm/models/UpdateGroupPermissionRequest.d.ts +6 -0
- package/dist/esm/models/UpdateGroupPermissionRequest.js +2 -0
- package/dist/esm/models/UpdatePermissionRequest.d.ts +6 -0
- package/dist/esm/models/UpdatePermissionRequest.js +2 -0
- package/dist/esm/models/UpdateTableRequest.d.ts +54 -0
- package/dist/esm/models/UpdateTableRequest.js +45 -0
- package/dist/esm/models/VersionDiffResponse.d.ts +89 -0
- package/dist/esm/models/VersionDiffResponse.js +63 -0
- package/dist/esm/models/WorkflowDefinitionResponse.d.ts +7 -0
- package/dist/esm/models/WorkflowDefinitionResponse.js +3 -0
- package/dist/esm/models/WorkflowRunResponse.d.ts +7 -0
- package/dist/esm/models/WorkflowRunResponse.js +3 -0
- package/dist/esm/models/index.d.ts +37 -2
- package/dist/esm/models/index.js +37 -2
- package/dist/models/AccessCheckResponse.d.ts +59 -0
- package/dist/models/AccessCheckResponse.js +58 -0
- package/dist/models/CatalogColumnResponse.d.ts +59 -0
- package/dist/models/CatalogColumnResponse.js +60 -0
- package/dist/models/CatalogTableResponse.d.ts +54 -0
- package/dist/models/CatalogTableResponse.js +57 -0
- package/dist/models/CellChange.d.ts +72 -0
- package/dist/models/CellChange.js +69 -0
- package/dist/models/CellChangeType.d.ts +26 -0
- package/dist/models/CellChangeType.js +52 -0
- package/dist/models/CellDiff.d.ts +72 -0
- package/dist/models/CellDiff.js +69 -0
- package/dist/models/ColumnConfig.d.ts +71 -0
- package/dist/models/ColumnConfig.js +60 -0
- package/dist/models/ConnectionConfig.d.ts +71 -0
- package/dist/models/ConnectionConfig.js +66 -0
- package/dist/models/CreateDataSourceRequest.d.ts +67 -0
- package/dist/models/CreateDataSourceRequest.js +70 -0
- package/dist/models/CreateGroupPermissionRequest.d.ts +6 -0
- package/dist/models/CreateGroupPermissionRequest.js +2 -0
- package/dist/models/CreatePermissionRequest.d.ts +6 -0
- package/dist/models/CreatePermissionRequest.js +2 -0
- package/dist/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
- package/dist/models/CreateWorkflowDefinitionRequest.js +4 -0
- package/dist/models/DataSourceCatalogResponse.d.ts +48 -0
- package/dist/models/DataSourceCatalogResponse.js +53 -0
- package/dist/models/DataSourceDetailResponse.d.ts +55 -0
- package/dist/models/DataSourceDetailResponse.js +58 -0
- package/dist/models/DataSourceEngine.d.ts +25 -0
- package/dist/models/DataSourceEngine.js +51 -0
- package/dist/models/DataSourceQueryRequest.d.ts +53 -0
- package/dist/models/DataSourceQueryRequest.js +61 -0
- package/dist/models/DataSourceQueryResponse.d.ts +71 -0
- package/dist/models/DataSourceQueryResponse.js +68 -0
- package/dist/models/DataSourceResponse.d.ts +119 -0
- package/dist/models/DataSourceResponse.js +98 -0
- package/dist/models/DataSourceTableResponse.d.ts +135 -0
- package/dist/models/DataSourceTableResponse.js +109 -0
- package/dist/models/DiffFormat.d.ts +25 -0
- package/dist/models/DiffFormat.js +51 -0
- package/dist/models/DiffRow.d.ts +90 -0
- package/dist/models/DiffRow.js +66 -0
- package/dist/models/DiffRowType.d.ts +27 -0
- package/dist/models/DiffRowType.js +53 -0
- package/dist/models/DiffSpan.d.ts +53 -0
- package/dist/models/DiffSpan.js +56 -0
- package/dist/models/DocumentDownloadResponse.d.ts +72 -0
- package/dist/models/DocumentDownloadResponse.js +69 -0
- package/dist/models/DocumentResponse.d.ts +4 -3
- package/dist/models/DocumentResponse.js +3 -2
- package/dist/models/DownloadArtifact.d.ts +25 -0
- package/dist/models/DownloadArtifact.js +51 -0
- package/dist/models/EventResponse.d.ts +7 -0
- package/dist/models/EventResponse.js +3 -0
- package/dist/models/FolderResponse.d.ts +4 -3
- package/dist/models/FolderResponse.js +3 -2
- package/dist/models/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.d.ts +39 -0
- package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.js} +20 -10
- package/dist/models/GroupPermissionResponse.d.ts +6 -0
- package/dist/models/GroupPermissionResponse.js +4 -0
- package/dist/models/ItemPermissions.d.ts +73 -0
- package/dist/models/ItemPermissions.js +64 -0
- package/dist/models/MemoryBodyResponse.d.ts +60 -0
- package/dist/models/MemoryBodyResponse.js +61 -0
- package/dist/models/MemoryScope.d.ts +29 -0
- package/dist/models/MemoryScope.js +55 -0
- package/dist/models/ModelTableRequest.d.ts +66 -0
- package/dist/models/ModelTableRequest.js +59 -0
- package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.d.ts +66 -0
- package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.js +78 -0
- package/dist/models/PaginatedResponsePendingMemoryChunkResponse.d.ts +66 -0
- package/dist/models/PaginatedResponsePendingMemoryChunkResponse.js +78 -0
- package/dist/models/PaginatedResponseTrashItemResponse.d.ts +66 -0
- package/dist/models/PaginatedResponseTrashItemResponse.js +78 -0
- package/dist/models/PartType.d.ts +2 -0
- package/dist/models/PartType.js +3 -1
- package/dist/models/PathPartResponse.d.ts +4 -9
- package/dist/models/PathPartResponse.js +4 -7
- package/dist/models/PendingMemoryChunkResponse.d.ts +91 -0
- package/dist/models/PendingMemoryChunkResponse.js +82 -0
- package/dist/models/PermissionCapability.d.ts +2 -1
- package/dist/models/PermissionCapability.js +3 -2
- package/dist/models/PermissionResponse.d.ts +6 -0
- package/dist/models/PermissionResponse.js +4 -0
- package/dist/models/ProposeMemoryChunkRequest.d.ts +79 -0
- package/dist/models/ProposeMemoryChunkRequest.js +79 -0
- package/dist/models/ProposedMemoryChunkResponse.d.ts +91 -0
- package/dist/models/ProposedMemoryChunkResponse.js +82 -0
- package/dist/models/ReferenceType.d.ts +2 -0
- package/dist/models/ReferenceType.js +2 -0
- package/dist/models/TextDiff.d.ts +72 -0
- package/dist/models/TextDiff.js +69 -0
- package/dist/models/TrashItemResponse.d.ts +90 -0
- package/dist/models/TrashItemResponse.js +81 -0
- package/dist/models/UpdateGroupPermissionRequest.d.ts +6 -0
- package/dist/models/UpdateGroupPermissionRequest.js +2 -0
- package/dist/models/UpdatePermissionRequest.d.ts +6 -0
- package/dist/models/UpdatePermissionRequest.js +2 -0
- package/dist/models/UpdateTableRequest.d.ts +54 -0
- package/dist/models/UpdateTableRequest.js +53 -0
- package/dist/models/VersionDiffResponse.d.ts +89 -0
- package/dist/models/VersionDiffResponse.js +71 -0
- package/dist/models/WorkflowDefinitionResponse.d.ts +7 -0
- package/dist/models/WorkflowDefinitionResponse.js +3 -0
- package/dist/models/WorkflowRunResponse.d.ts +7 -0
- package/dist/models/WorkflowRunResponse.js +3 -0
- package/dist/models/index.d.ts +37 -2
- package/dist/models/index.js +37 -2
- package/docs/AccessCheckResponse.md +39 -0
- package/docs/AgentApi.md +18 -18
- package/docs/ApiKeysApi.md +30 -32
- package/docs/AuditEventsApi.md +104 -0
- package/docs/AuthApi.md +36 -36
- package/docs/CatalogColumnResponse.md +38 -0
- package/docs/CatalogTableResponse.md +36 -0
- package/docs/CellChange.md +43 -0
- package/docs/CellChangeType.md +32 -0
- package/docs/CellDiff.md +43 -0
- package/docs/ChunkLineagesApi.md +27 -27
- package/docs/ChunksApi.md +82 -82
- package/docs/ColumnConfig.md +43 -0
- package/docs/ConnectionConfig.md +43 -0
- package/docs/CreateDataSourceRequest.md +41 -0
- package/docs/CreateGroupPermissionRequest.md +2 -0
- package/docs/CreatePermissionRequest.md +2 -0
- package/docs/CreateWorkflowDefinitionRequest.md +2 -0
- package/docs/DataSourceCatalogResponse.md +35 -0
- package/docs/DataSourceDetailResponse.md +37 -0
- package/docs/DataSourceEngine.md +33 -0
- package/docs/DataSourceQueryRequest.md +37 -0
- package/docs/DataSourceQueryResponse.md +43 -0
- package/docs/DataSourceResponse.md +55 -0
- package/docs/DataSourceTableResponse.md +61 -0
- package/docs/DataSourcesApi.md +545 -0
- package/docs/DiffFormat.md +32 -0
- package/docs/DiffRow.md +47 -0
- package/docs/DiffRowType.md +32 -0
- package/docs/DiffSpan.md +37 -0
- package/docs/DocumentCheckoutApi.md +27 -27
- package/docs/DocumentDownloadResponse.md +43 -0
- package/docs/DocumentResponse.md +2 -2
- package/docs/DocumentVersionsApi.md +228 -72
- package/docs/DocumentsApi.md +154 -64
- package/docs/DownloadArtifact.md +32 -0
- package/docs/EventResponse.md +2 -0
- package/docs/FeedbackApi.md +27 -27
- package/docs/FolderResponse.md +2 -2
- package/docs/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse.md → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.md} +14 -6
- package/docs/FoldersApi.md +75 -75
- package/docs/GroupPermissionResponse.md +2 -0
- package/docs/InvitesApi.md +45 -45
- package/docs/ItemPermissions.md +41 -0
- package/docs/MemoryApi.md +379 -0
- package/docs/MemoryBodyResponse.md +38 -0
- package/docs/MemoryScope.md +33 -0
- package/docs/ModelTableRequest.md +41 -0
- package/docs/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.md → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.md} +5 -5
- package/docs/PaginatedResponsePendingMemoryChunkResponse.md +40 -0
- package/docs/PaginatedResponseTrashItemResponse.md +40 -0
- package/docs/PathPartApprovalsApi.md +18 -18
- package/docs/PathPartResponse.md +2 -4
- package/docs/PathPartsApi.md +162 -81
- package/docs/PendingMemoryChunkResponse.md +48 -0
- package/docs/PermissionCapability.md +1 -1
- package/docs/PermissionResponse.md +2 -0
- package/docs/ProposeMemoryChunkRequest.md +44 -0
- package/docs/ProposedMemoryChunkResponse.md +48 -0
- package/docs/SectionsApi.md +54 -54
- package/docs/SubscriptionsApi.md +18 -18
- package/docs/TagsApi.md +45 -45
- package/docs/TenantGroupsApi.md +119 -125
- package/docs/TenantsApi.md +108 -108
- package/docs/TextDiff.md +43 -0
- package/docs/ThreadMessagesApi.md +27 -27
- package/docs/ThreadsApi.md +63 -63
- package/docs/TrashApi.md +236 -0
- package/docs/TrashItemResponse.md +49 -0
- package/docs/UpdateGroupPermissionRequest.md +2 -0
- package/docs/UpdatePermissionRequest.md +2 -0
- package/docs/UpdateTableRequest.md +37 -0
- package/docs/UserPermissionsApi.md +36 -36
- package/docs/UsersApi.md +49 -61
- package/docs/VersionDiffResponse.md +47 -0
- package/docs/WorkflowDefinitionResponse.md +2 -0
- package/docs/WorkflowDefinitionsApi.md +63 -63
- package/docs/WorkflowMemoryApi.md +45 -45
- package/docs/WorkflowRunResponse.md +2 -0
- package/docs/WorkflowRunsApi.md +82 -82
- package/docs/WorkflowsApi.md +45 -45
- package/package.json +1 -1
- package/src/apis/AgentApi.ts +14 -18
- package/src/apis/ApiKeysApi.ts +8 -23
- package/src/apis/AuditEventsApi.ts +170 -0
- package/src/apis/AuthApi.ts +28 -36
- package/src/apis/ChunkLineagesApi.ts +21 -27
- package/src/apis/ChunksApi.ts +63 -81
- package/src/apis/DataSourcesApi.ts +698 -0
- package/src/apis/DocumentCheckoutApi.ts +21 -27
- package/src/apis/DocumentVersionsApi.ts +245 -72
- package/src/apis/DocumentsApi.ts +177 -67
- package/src/apis/FeedbackApi.ts +21 -27
- package/src/apis/FoldersApi.ts +73 -89
- package/src/apis/InvitesApi.ts +35 -45
- package/src/apis/MemoryApi.ts +478 -0
- package/src/apis/PathPartApprovalsApi.ts +14 -18
- package/src/apis/PathPartsApi.ts +173 -81
- package/src/apis/SectionsApi.ts +42 -54
- package/src/apis/SubscriptionsApi.ts +14 -18
- package/src/apis/TagsApi.ts +35 -45
- package/src/apis/TenantGroupsApi.ts +99 -128
- package/src/apis/TenantsApi.ts +84 -108
- package/src/apis/ThreadMessagesApi.ts +21 -27
- package/src/apis/ThreadsApi.ts +49 -63
- package/src/apis/TrashApi.ts +292 -0
- package/src/apis/UserPermissionsApi.ts +28 -36
- package/src/apis/UsersApi.ts +51 -67
- package/src/apis/WorkflowDefinitionsApi.ts +49 -63
- package/src/apis/WorkflowMemoryApi.ts +35 -45
- package/src/apis/WorkflowRunsApi.ts +67 -85
- package/src/apis/WorkflowsApi.ts +35 -45
- package/src/apis/index.ts +4 -0
- package/src/models/AccessCheckResponse.ts +100 -0
- package/src/models/CatalogColumnResponse.ts +101 -0
- package/src/models/CatalogTableResponse.ts +100 -0
- package/src/models/CellChange.ts +129 -0
- package/src/models/CellChangeType.ts +54 -0
- package/src/models/CellDiff.ts +127 -0
- package/src/models/ColumnConfig.ts +115 -0
- package/src/models/ConnectionConfig.ts +118 -0
- package/src/models/CreateDataSourceRequest.ts +130 -0
- package/src/models/CreateGroupPermissionRequest.ts +8 -0
- package/src/models/CreatePermissionRequest.ts +8 -0
- package/src/models/CreateWorkflowDefinitionRequest.ts +9 -0
- package/src/models/DataSourceCatalogResponse.ts +91 -0
- package/src/models/DataSourceDetailResponse.ts +107 -0
- package/src/models/DataSourceEngine.ts +53 -0
- package/src/models/DataSourceQueryRequest.ts +97 -0
- package/src/models/DataSourceQueryResponse.ts +119 -0
- package/src/models/DataSourceResponse.ts +200 -0
- package/src/models/DataSourceTableResponse.ts +217 -0
- package/src/models/DiffFormat.ts +53 -0
- package/src/models/DiffRow.ts +153 -0
- package/src/models/DiffRowType.ts +55 -0
- package/src/models/DiffSpan.ts +92 -0
- package/src/models/DocumentDownloadResponse.ts +129 -0
- package/src/models/DocumentResponse.ts +12 -5
- package/src/models/DownloadArtifact.ts +53 -0
- package/src/models/EventResponse.ts +16 -0
- package/src/models/FolderResponse.ts +12 -5
- package/src/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.ts} +30 -8
- package/src/models/GroupPermissionResponse.ts +9 -0
- package/src/models/ItemPermissions.ts +118 -0
- package/src/models/MemoryBodyResponse.ts +111 -0
- package/src/models/MemoryScope.ts +57 -0
- package/src/models/ModelTableRequest.ts +115 -0
- package/src/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.ts} +25 -25
- package/src/models/PaginatedResponsePendingMemoryChunkResponse.ts +130 -0
- package/src/models/PaginatedResponseTrashItemResponse.ts +130 -0
- package/src/models/PartType.ts +3 -1
- package/src/models/PathPartResponse.ts +13 -15
- package/src/models/PendingMemoryChunkResponse.ts +163 -0
- package/src/models/PermissionCapability.ts +3 -2
- package/src/models/PermissionResponse.ts +9 -0
- package/src/models/ProposeMemoryChunkRequest.ts +151 -0
- package/src/models/ProposedMemoryChunkResponse.ts +163 -0
- package/src/models/ReferenceType.ts +2 -0
- package/src/models/TextDiff.ts +127 -0
- package/src/models/TrashItemResponse.ts +156 -0
- package/src/models/UpdateGroupPermissionRequest.ts +8 -0
- package/src/models/UpdatePermissionRequest.ts +8 -0
- package/src/models/UpdateTableRequest.ts +98 -0
- package/src/models/VersionDiffResponse.ts +160 -0
- package/src/models/WorkflowDefinitionResponse.ts +15 -0
- package/src/models/WorkflowRunResponse.ts +15 -0
- package/src/models/index.ts +37 -2
- package/dist/esm/models/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse.d.ts +0 -33
- package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.d.ts +0 -66
- package/dist/models/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse.d.ts +0 -33
- package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.d.ts +0 -66
- package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.js +0 -78
package/docs/DocumentsApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**createDocument**](DocumentsApi.md#createdocumentoperation) | **POST** /v1/documents | Create Document Handler |
|
|
8
8
|
| [**deleteDocument**](DocumentsApi.md#deletedocument) | **DELETE** /v1/documents/{document_id} | Delete Document Handler |
|
|
9
|
+
| [**downloadDocument**](DocumentsApi.md#downloaddocument) | **POST** /v1/documents/{document_id}/download | Download Document Handler |
|
|
9
10
|
| [**getDocument**](DocumentsApi.md#getdocument) | **GET** /v1/documents/{document_id} | Get Document Handler |
|
|
10
11
|
| [**ingestDocument**](DocumentsApi.md#ingestdocument) | **POST** /v1/documents/ingest | Ingest Document Handler |
|
|
11
12
|
| [**ingestDocumentVersion**](DocumentsApi.md#ingestdocumentversion) | **POST** /v1/documents/{document_id}/ingest | Ingest Document Version Handler |
|
|
@@ -16,7 +17,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
16
17
|
|
|
17
18
|
## createDocument
|
|
18
19
|
|
|
19
|
-
> DocumentResponse createDocument(createDocumentRequest
|
|
20
|
+
> DocumentResponse createDocument(createDocumentRequest)
|
|
20
21
|
|
|
21
22
|
Create Document Handler
|
|
22
23
|
|
|
@@ -33,15 +34,17 @@ import type { CreateDocumentOperationRequest } from '@knowledge-stack/ksapi';
|
|
|
33
34
|
|
|
34
35
|
async function example() {
|
|
35
36
|
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
36
|
-
const
|
|
37
|
+
const config = new Configuration({
|
|
38
|
+
// To configure API key authorization: cookieAuth
|
|
39
|
+
apiKey: "YOUR API KEY",
|
|
40
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
41
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
42
|
+
});
|
|
43
|
+
const api = new DocumentsApi(config);
|
|
37
44
|
|
|
38
45
|
const body = {
|
|
39
46
|
// CreateDocumentRequest
|
|
40
47
|
createDocumentRequest: ...,
|
|
41
|
-
// string (optional)
|
|
42
|
-
authorization: authorization_example,
|
|
43
|
-
// string (optional)
|
|
44
|
-
ksUat: ksUat_example,
|
|
45
48
|
} satisfies CreateDocumentOperationRequest;
|
|
46
49
|
|
|
47
50
|
try {
|
|
@@ -62,8 +65,6 @@ example().catch(console.error);
|
|
|
62
65
|
| Name | Type | Description | Notes |
|
|
63
66
|
|------------- | ------------- | ------------- | -------------|
|
|
64
67
|
| **createDocumentRequest** | [CreateDocumentRequest](CreateDocumentRequest.md) | | |
|
|
65
|
-
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
66
|
-
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
67
68
|
|
|
68
69
|
### Return type
|
|
69
70
|
|
|
@@ -71,7 +72,7 @@ example().catch(console.error);
|
|
|
71
72
|
|
|
72
73
|
### Authorization
|
|
73
74
|
|
|
74
|
-
|
|
75
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
75
76
|
|
|
76
77
|
### HTTP request headers
|
|
77
78
|
|
|
@@ -90,11 +91,11 @@ No authorization required
|
|
|
90
91
|
|
|
91
92
|
## deleteDocument
|
|
92
93
|
|
|
93
|
-
> deleteDocument(documentId
|
|
94
|
+
> deleteDocument(documentId)
|
|
94
95
|
|
|
95
96
|
Delete Document Handler
|
|
96
97
|
|
|
97
|
-
|
|
98
|
+
Move a document and all its contents to trash.
|
|
98
99
|
|
|
99
100
|
### Example
|
|
100
101
|
|
|
@@ -107,15 +108,17 @@ import type { DeleteDocumentRequest } from '@knowledge-stack/ksapi';
|
|
|
107
108
|
|
|
108
109
|
async function example() {
|
|
109
110
|
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
110
|
-
const
|
|
111
|
+
const config = new Configuration({
|
|
112
|
+
// To configure API key authorization: cookieAuth
|
|
113
|
+
apiKey: "YOUR API KEY",
|
|
114
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
115
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
116
|
+
});
|
|
117
|
+
const api = new DocumentsApi(config);
|
|
111
118
|
|
|
112
119
|
const body = {
|
|
113
120
|
// string
|
|
114
121
|
documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
115
|
-
// string (optional)
|
|
116
|
-
authorization: authorization_example,
|
|
117
|
-
// string (optional)
|
|
118
|
-
ksUat: ksUat_example,
|
|
119
122
|
} satisfies DeleteDocumentRequest;
|
|
120
123
|
|
|
121
124
|
try {
|
|
@@ -136,8 +139,6 @@ example().catch(console.error);
|
|
|
136
139
|
| Name | Type | Description | Notes |
|
|
137
140
|
|------------- | ------------- | ------------- | -------------|
|
|
138
141
|
| **documentId** | `string` | | [Defaults to `undefined`] |
|
|
139
|
-
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
140
|
-
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
141
142
|
|
|
142
143
|
### Return type
|
|
143
144
|
|
|
@@ -145,7 +146,7 @@ example().catch(console.error);
|
|
|
145
146
|
|
|
146
147
|
### Authorization
|
|
147
148
|
|
|
148
|
-
|
|
149
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
149
150
|
|
|
150
151
|
### HTTP request headers
|
|
151
152
|
|
|
@@ -162,9 +163,86 @@ No authorization required
|
|
|
162
163
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
163
164
|
|
|
164
165
|
|
|
166
|
+
## downloadDocument
|
|
167
|
+
|
|
168
|
+
> DocumentDownloadResponse downloadDocument(documentId, artifact)
|
|
169
|
+
|
|
170
|
+
Download Document Handler
|
|
171
|
+
|
|
172
|
+
Issue a short-lived, audited download link for a document\'s active version. Records a ``document.downloaded`` audit event so the customer audit log captures who downloaded which document/version and when.
|
|
173
|
+
|
|
174
|
+
### Example
|
|
175
|
+
|
|
176
|
+
```ts
|
|
177
|
+
import {
|
|
178
|
+
Configuration,
|
|
179
|
+
DocumentsApi,
|
|
180
|
+
} from '@knowledge-stack/ksapi';
|
|
181
|
+
import type { DownloadDocumentRequest } from '@knowledge-stack/ksapi';
|
|
182
|
+
|
|
183
|
+
async function example() {
|
|
184
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
185
|
+
const config = new Configuration({
|
|
186
|
+
// To configure API key authorization: cookieAuth
|
|
187
|
+
apiKey: "YOUR API KEY",
|
|
188
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
189
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
190
|
+
});
|
|
191
|
+
const api = new DocumentsApi(config);
|
|
192
|
+
|
|
193
|
+
const body = {
|
|
194
|
+
// string
|
|
195
|
+
documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
196
|
+
// DownloadArtifact | Artifact to download: source or fast_plaintext (optional)
|
|
197
|
+
artifact: ...,
|
|
198
|
+
} satisfies DownloadDocumentRequest;
|
|
199
|
+
|
|
200
|
+
try {
|
|
201
|
+
const data = await api.downloadDocument(body);
|
|
202
|
+
console.log(data);
|
|
203
|
+
} catch (error) {
|
|
204
|
+
console.error(error);
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
// Run the test
|
|
209
|
+
example().catch(console.error);
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Parameters
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
| Name | Type | Description | Notes |
|
|
216
|
+
|------------- | ------------- | ------------- | -------------|
|
|
217
|
+
| **documentId** | `string` | | [Defaults to `undefined`] |
|
|
218
|
+
| **artifact** | `DownloadArtifact` | Artifact to download: source or fast_plaintext | [Optional] [Defaults to `undefined`] [Enum: source, fast_plaintext] |
|
|
219
|
+
|
|
220
|
+
### Return type
|
|
221
|
+
|
|
222
|
+
[**DocumentDownloadResponse**](DocumentDownloadResponse.md)
|
|
223
|
+
|
|
224
|
+
### Authorization
|
|
225
|
+
|
|
226
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
227
|
+
|
|
228
|
+
### HTTP request headers
|
|
229
|
+
|
|
230
|
+
- **Content-Type**: Not defined
|
|
231
|
+
- **Accept**: `application/json`
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
### HTTP response details
|
|
235
|
+
| Status code | Description | Response headers |
|
|
236
|
+
|-------------|-------------|------------------|
|
|
237
|
+
| **200** | Successful Response | - |
|
|
238
|
+
| **422** | Validation Error | - |
|
|
239
|
+
|
|
240
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
241
|
+
|
|
242
|
+
|
|
165
243
|
## getDocument
|
|
166
244
|
|
|
167
|
-
> DocumentResponse getDocument(documentId, withTags
|
|
245
|
+
> DocumentResponse getDocument(documentId, withTags)
|
|
168
246
|
|
|
169
247
|
Get Document Handler
|
|
170
248
|
|
|
@@ -179,17 +257,19 @@ import type { GetDocumentRequest } from '@knowledge-stack/ksapi';
|
|
|
179
257
|
|
|
180
258
|
async function example() {
|
|
181
259
|
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
182
|
-
const
|
|
260
|
+
const config = new Configuration({
|
|
261
|
+
// To configure API key authorization: cookieAuth
|
|
262
|
+
apiKey: "YOUR API KEY",
|
|
263
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
264
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
265
|
+
});
|
|
266
|
+
const api = new DocumentsApi(config);
|
|
183
267
|
|
|
184
268
|
const body = {
|
|
185
269
|
// string
|
|
186
270
|
documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
187
271
|
// boolean | Include tags in the response (default: false) (optional)
|
|
188
272
|
withTags: true,
|
|
189
|
-
// string (optional)
|
|
190
|
-
authorization: authorization_example,
|
|
191
|
-
// string (optional)
|
|
192
|
-
ksUat: ksUat_example,
|
|
193
273
|
} satisfies GetDocumentRequest;
|
|
194
274
|
|
|
195
275
|
try {
|
|
@@ -211,8 +291,6 @@ example().catch(console.error);
|
|
|
211
291
|
|------------- | ------------- | ------------- | -------------|
|
|
212
292
|
| **documentId** | `string` | | [Defaults to `undefined`] |
|
|
213
293
|
| **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
|
|
214
|
-
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
215
|
-
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
216
294
|
|
|
217
295
|
### Return type
|
|
218
296
|
|
|
@@ -220,7 +298,7 @@ example().catch(console.error);
|
|
|
220
298
|
|
|
221
299
|
### Authorization
|
|
222
300
|
|
|
223
|
-
|
|
301
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
224
302
|
|
|
225
303
|
### HTTP request headers
|
|
226
304
|
|
|
@@ -239,7 +317,7 @@ No authorization required
|
|
|
239
317
|
|
|
240
318
|
## ingestDocument
|
|
241
319
|
|
|
242
|
-
> IngestDocumentResponse ingestDocument(file, pathPartId,
|
|
320
|
+
> IngestDocumentResponse ingestDocument(file, pathPartId, name, ingestionMode, chunkType, secondaryTaxonomy, pageDpi, workflowRunId, workflowDefinitionId)
|
|
243
321
|
|
|
244
322
|
Ingest Document Handler
|
|
245
323
|
|
|
@@ -256,17 +334,19 @@ import type { IngestDocumentRequest } from '@knowledge-stack/ksapi';
|
|
|
256
334
|
|
|
257
335
|
async function example() {
|
|
258
336
|
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
259
|
-
const
|
|
337
|
+
const config = new Configuration({
|
|
338
|
+
// To configure API key authorization: cookieAuth
|
|
339
|
+
apiKey: "YOUR API KEY",
|
|
340
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
341
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
342
|
+
});
|
|
343
|
+
const api = new DocumentsApi(config);
|
|
260
344
|
|
|
261
345
|
const body = {
|
|
262
346
|
// Blob
|
|
263
347
|
file: BINARY_DATA_HERE,
|
|
264
348
|
// string | Parent path part ID (must be a FOLDER type)
|
|
265
349
|
pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
266
|
-
// string (optional)
|
|
267
|
-
authorization: authorization_example,
|
|
268
|
-
// string (optional)
|
|
269
|
-
ksUat: ksUat_example,
|
|
270
350
|
// string | Document name (defaults to filename) (optional)
|
|
271
351
|
name: name_example,
|
|
272
352
|
// IngestionMode (optional)
|
|
@@ -277,6 +357,10 @@ async function example() {
|
|
|
277
357
|
secondaryTaxonomy: ...,
|
|
278
358
|
// number | DPI for PDF page screenshots (default 72, min 36, max 216). (optional)
|
|
279
359
|
pageDpi: 56,
|
|
360
|
+
// string | Workflow run context for assumed agent uploads. (optional)
|
|
361
|
+
workflowRunId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
362
|
+
// string | Workflow definition context for assumed agent uploads. (optional)
|
|
363
|
+
workflowDefinitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
280
364
|
} satisfies IngestDocumentRequest;
|
|
281
365
|
|
|
282
366
|
try {
|
|
@@ -298,13 +382,13 @@ example().catch(console.error);
|
|
|
298
382
|
|------------- | ------------- | ------------- | -------------|
|
|
299
383
|
| **file** | `Blob` | | [Defaults to `undefined`] |
|
|
300
384
|
| **pathPartId** | `string` | Parent path part ID (must be a FOLDER type) | [Defaults to `undefined`] |
|
|
301
|
-
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
302
|
-
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
303
385
|
| **name** | `string` | Document name (defaults to filename) | [Optional] [Defaults to `undefined`] |
|
|
304
386
|
| **ingestionMode** | `IngestionMode` | | [Optional] [Defaults to `undefined`] [Enum: high_accuracy, standard, single_chunk] |
|
|
305
387
|
| **chunkType** | `ChunkType` | | [Optional] [Defaults to `undefined`] [Enum: TEXT, TABLE, IMAGE, HTML, UNKNOWN] |
|
|
306
388
|
| **secondaryTaxonomy** | `ImageTaxonomy` | | [Optional] [Defaults to `undefined`] [Enum: picture, flowchart] |
|
|
307
389
|
| **pageDpi** | `number` | DPI for PDF page screenshots (default 72, min 36, max 216). | [Optional] [Defaults to `72`] |
|
|
390
|
+
| **workflowRunId** | `string` | Workflow run context for assumed agent uploads. | [Optional] [Defaults to `undefined`] |
|
|
391
|
+
| **workflowDefinitionId** | `string` | Workflow definition context for assumed agent uploads. | [Optional] [Defaults to `undefined`] |
|
|
308
392
|
|
|
309
393
|
### Return type
|
|
310
394
|
|
|
@@ -312,7 +396,7 @@ example().catch(console.error);
|
|
|
312
396
|
|
|
313
397
|
### Authorization
|
|
314
398
|
|
|
315
|
-
|
|
399
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
316
400
|
|
|
317
401
|
### HTTP request headers
|
|
318
402
|
|
|
@@ -331,7 +415,7 @@ No authorization required
|
|
|
331
415
|
|
|
332
416
|
## ingestDocumentVersion
|
|
333
417
|
|
|
334
|
-
> IngestDocumentResponse ingestDocumentVersion(documentId, file,
|
|
418
|
+
> IngestDocumentResponse ingestDocumentVersion(documentId, file, ingestionMode, chunkType, secondaryTaxonomy, pageDpi, workflowRunId, workflowDefinitionId)
|
|
335
419
|
|
|
336
420
|
Ingest Document Version Handler
|
|
337
421
|
|
|
@@ -348,17 +432,19 @@ import type { IngestDocumentVersionRequest } from '@knowledge-stack/ksapi';
|
|
|
348
432
|
|
|
349
433
|
async function example() {
|
|
350
434
|
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
351
|
-
const
|
|
435
|
+
const config = new Configuration({
|
|
436
|
+
// To configure API key authorization: cookieAuth
|
|
437
|
+
apiKey: "YOUR API KEY",
|
|
438
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
439
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
440
|
+
});
|
|
441
|
+
const api = new DocumentsApi(config);
|
|
352
442
|
|
|
353
443
|
const body = {
|
|
354
444
|
// string | Document ID
|
|
355
445
|
documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
356
446
|
// Blob
|
|
357
447
|
file: BINARY_DATA_HERE,
|
|
358
|
-
// string (optional)
|
|
359
|
-
authorization: authorization_example,
|
|
360
|
-
// string (optional)
|
|
361
|
-
ksUat: ksUat_example,
|
|
362
448
|
// IngestionMode (optional)
|
|
363
449
|
ingestionMode: ...,
|
|
364
450
|
// ChunkType (optional)
|
|
@@ -367,6 +453,10 @@ async function example() {
|
|
|
367
453
|
secondaryTaxonomy: ...,
|
|
368
454
|
// number | DPI for PDF page screenshots (default 72, min 36, max 216). (optional)
|
|
369
455
|
pageDpi: 56,
|
|
456
|
+
// string | Workflow run context for assumed agent uploads. (optional)
|
|
457
|
+
workflowRunId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
458
|
+
// string | Workflow definition context for assumed agent uploads. (optional)
|
|
459
|
+
workflowDefinitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
370
460
|
} satisfies IngestDocumentVersionRequest;
|
|
371
461
|
|
|
372
462
|
try {
|
|
@@ -388,12 +478,12 @@ example().catch(console.error);
|
|
|
388
478
|
|------------- | ------------- | ------------- | -------------|
|
|
389
479
|
| **documentId** | `string` | Document ID | [Defaults to `undefined`] |
|
|
390
480
|
| **file** | `Blob` | | [Defaults to `undefined`] |
|
|
391
|
-
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
392
|
-
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
393
481
|
| **ingestionMode** | `IngestionMode` | | [Optional] [Defaults to `undefined`] [Enum: high_accuracy, standard, single_chunk] |
|
|
394
482
|
| **chunkType** | `ChunkType` | | [Optional] [Defaults to `undefined`] [Enum: TEXT, TABLE, IMAGE, HTML, UNKNOWN] |
|
|
395
483
|
| **secondaryTaxonomy** | `ImageTaxonomy` | | [Optional] [Defaults to `undefined`] [Enum: picture, flowchart] |
|
|
396
484
|
| **pageDpi** | `number` | DPI for PDF page screenshots (default 72, min 36, max 216). | [Optional] [Defaults to `72`] |
|
|
485
|
+
| **workflowRunId** | `string` | Workflow run context for assumed agent uploads. | [Optional] [Defaults to `undefined`] |
|
|
486
|
+
| **workflowDefinitionId** | `string` | Workflow definition context for assumed agent uploads. | [Optional] [Defaults to `undefined`] |
|
|
397
487
|
|
|
398
488
|
### Return type
|
|
399
489
|
|
|
@@ -401,7 +491,7 @@ example().catch(console.error);
|
|
|
401
491
|
|
|
402
492
|
### Authorization
|
|
403
493
|
|
|
404
|
-
|
|
494
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
405
495
|
|
|
406
496
|
### HTTP request headers
|
|
407
497
|
|
|
@@ -420,7 +510,7 @@ No authorization required
|
|
|
420
510
|
|
|
421
511
|
## listDocuments
|
|
422
512
|
|
|
423
|
-
> PaginatedResponseDocumentResponse listDocuments(parentPathPartId, sortOrder, withTags, limit, offset
|
|
513
|
+
> PaginatedResponseDocumentResponse listDocuments(parentPathPartId, sortOrder, withTags, limit, offset)
|
|
424
514
|
|
|
425
515
|
List Documents Handler
|
|
426
516
|
|
|
@@ -437,7 +527,13 @@ import type { ListDocumentsRequest } from '@knowledge-stack/ksapi';
|
|
|
437
527
|
|
|
438
528
|
async function example() {
|
|
439
529
|
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
440
|
-
const
|
|
530
|
+
const config = new Configuration({
|
|
531
|
+
// To configure API key authorization: cookieAuth
|
|
532
|
+
apiKey: "YOUR API KEY",
|
|
533
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
534
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
535
|
+
});
|
|
536
|
+
const api = new DocumentsApi(config);
|
|
441
537
|
|
|
442
538
|
const body = {
|
|
443
539
|
// string | Parent PathPart ID (defaults to root) (optional)
|
|
@@ -450,10 +546,6 @@ async function example() {
|
|
|
450
546
|
limit: 56,
|
|
451
547
|
// number | Number of items to skip (optional)
|
|
452
548
|
offset: 56,
|
|
453
|
-
// string (optional)
|
|
454
|
-
authorization: authorization_example,
|
|
455
|
-
// string (optional)
|
|
456
|
-
ksUat: ksUat_example,
|
|
457
549
|
} satisfies ListDocumentsRequest;
|
|
458
550
|
|
|
459
551
|
try {
|
|
@@ -478,8 +570,6 @@ example().catch(console.error);
|
|
|
478
570
|
| **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
|
|
479
571
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
480
572
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
481
|
-
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
482
|
-
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
483
573
|
|
|
484
574
|
### Return type
|
|
485
575
|
|
|
@@ -487,7 +577,7 @@ example().catch(console.error);
|
|
|
487
577
|
|
|
488
578
|
### Authorization
|
|
489
579
|
|
|
490
|
-
|
|
580
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
491
581
|
|
|
492
582
|
### HTTP request headers
|
|
493
583
|
|
|
@@ -506,7 +596,7 @@ No authorization required
|
|
|
506
596
|
|
|
507
597
|
## updateDocument
|
|
508
598
|
|
|
509
|
-
> DocumentResponse updateDocument(documentId, updateDocumentRequest
|
|
599
|
+
> DocumentResponse updateDocument(documentId, updateDocumentRequest)
|
|
510
600
|
|
|
511
601
|
Update Document Handler
|
|
512
602
|
|
|
@@ -523,17 +613,19 @@ import type { UpdateDocumentOperationRequest } from '@knowledge-stack/ksapi';
|
|
|
523
613
|
|
|
524
614
|
async function example() {
|
|
525
615
|
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
526
|
-
const
|
|
616
|
+
const config = new Configuration({
|
|
617
|
+
// To configure API key authorization: cookieAuth
|
|
618
|
+
apiKey: "YOUR API KEY",
|
|
619
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
620
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
621
|
+
});
|
|
622
|
+
const api = new DocumentsApi(config);
|
|
527
623
|
|
|
528
624
|
const body = {
|
|
529
625
|
// string
|
|
530
626
|
documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
531
627
|
// UpdateDocumentRequest
|
|
532
628
|
updateDocumentRequest: ...,
|
|
533
|
-
// string (optional)
|
|
534
|
-
authorization: authorization_example,
|
|
535
|
-
// string (optional)
|
|
536
|
-
ksUat: ksUat_example,
|
|
537
629
|
} satisfies UpdateDocumentOperationRequest;
|
|
538
630
|
|
|
539
631
|
try {
|
|
@@ -555,8 +647,6 @@ example().catch(console.error);
|
|
|
555
647
|
|------------- | ------------- | ------------- | -------------|
|
|
556
648
|
| **documentId** | `string` | | [Defaults to `undefined`] |
|
|
557
649
|
| **updateDocumentRequest** | [UpdateDocumentRequest](UpdateDocumentRequest.md) | | |
|
|
558
|
-
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
559
|
-
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
560
650
|
|
|
561
651
|
### Return type
|
|
562
652
|
|
|
@@ -564,7 +654,7 @@ example().catch(console.error);
|
|
|
564
654
|
|
|
565
655
|
### Authorization
|
|
566
656
|
|
|
567
|
-
|
|
657
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
568
658
|
|
|
569
659
|
### HTTP request headers
|
|
570
660
|
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
|
|
2
|
+
# DownloadArtifact
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import type { DownloadArtifact } from '@knowledge-stack/ksapi'
|
|
14
|
+
|
|
15
|
+
// TODO: Update the object below with actual values
|
|
16
|
+
const example = {
|
|
17
|
+
} satisfies DownloadArtifact
|
|
18
|
+
|
|
19
|
+
console.log(example)
|
|
20
|
+
|
|
21
|
+
// Convert the instance to a JSON string
|
|
22
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
23
|
+
console.log(exampleJSON)
|
|
24
|
+
|
|
25
|
+
// Parse the JSON string back to an object
|
|
26
|
+
const exampleParsed = JSON.parse(exampleJSON) as DownloadArtifact
|
|
27
|
+
console.log(exampleParsed)
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
31
|
+
|
|
32
|
+
|
package/docs/EventResponse.md
CHANGED
|
@@ -13,6 +13,7 @@ Name | Type
|
|
|
13
13
|
`ts` | Date
|
|
14
14
|
`actorUserId` | string
|
|
15
15
|
`payload` | { [key: string]: any; }
|
|
16
|
+
`actor` | [UserInfo](UserInfo.md)
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -27,6 +28,7 @@ const example = {
|
|
|
27
28
|
"ts": null,
|
|
28
29
|
"actorUserId": null,
|
|
29
30
|
"payload": null,
|
|
31
|
+
"actor": null,
|
|
30
32
|
} satisfies EventResponse
|
|
31
33
|
|
|
32
34
|
console.log(example)
|
package/docs/FeedbackApi.md
CHANGED
|
@@ -12,7 +12,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
12
12
|
|
|
13
13
|
## deleteFeedback
|
|
14
14
|
|
|
15
|
-
> deleteFeedback(feedbackId
|
|
15
|
+
> deleteFeedback(feedbackId)
|
|
16
16
|
|
|
17
17
|
Delete Feedback Handler
|
|
18
18
|
|
|
@@ -29,15 +29,17 @@ import type { DeleteFeedbackRequest } from '@knowledge-stack/ksapi';
|
|
|
29
29
|
|
|
30
30
|
async function example() {
|
|
31
31
|
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
32
|
-
const
|
|
32
|
+
const config = new Configuration({
|
|
33
|
+
// To configure API key authorization: cookieAuth
|
|
34
|
+
apiKey: "YOUR API KEY",
|
|
35
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
36
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
37
|
+
});
|
|
38
|
+
const api = new FeedbackApi(config);
|
|
33
39
|
|
|
34
40
|
const body = {
|
|
35
41
|
// string
|
|
36
42
|
feedbackId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
37
|
-
// string (optional)
|
|
38
|
-
authorization: authorization_example,
|
|
39
|
-
// string (optional)
|
|
40
|
-
ksUat: ksUat_example,
|
|
41
43
|
} satisfies DeleteFeedbackRequest;
|
|
42
44
|
|
|
43
45
|
try {
|
|
@@ -58,8 +60,6 @@ example().catch(console.error);
|
|
|
58
60
|
| Name | Type | Description | Notes |
|
|
59
61
|
|------------- | ------------- | ------------- | -------------|
|
|
60
62
|
| **feedbackId** | `string` | | [Defaults to `undefined`] |
|
|
61
|
-
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
62
|
-
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
63
63
|
|
|
64
64
|
### Return type
|
|
65
65
|
|
|
@@ -67,7 +67,7 @@ example().catch(console.error);
|
|
|
67
67
|
|
|
68
68
|
### Authorization
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
71
71
|
|
|
72
72
|
### HTTP request headers
|
|
73
73
|
|
|
@@ -86,7 +86,7 @@ No authorization required
|
|
|
86
86
|
|
|
87
87
|
## listFeedback
|
|
88
88
|
|
|
89
|
-
> PaginatedResponseFeedbackEventResponse listFeedback(targetType, targetId, rating, limit, offset
|
|
89
|
+
> PaginatedResponseFeedbackEventResponse listFeedback(targetType, targetId, rating, limit, offset)
|
|
90
90
|
|
|
91
91
|
List Feedback Handler
|
|
92
92
|
|
|
@@ -103,7 +103,13 @@ import type { ListFeedbackRequest } from '@knowledge-stack/ksapi';
|
|
|
103
103
|
|
|
104
104
|
async function example() {
|
|
105
105
|
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
106
|
-
const
|
|
106
|
+
const config = new Configuration({
|
|
107
|
+
// To configure API key authorization: cookieAuth
|
|
108
|
+
apiKey: "YOUR API KEY",
|
|
109
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
110
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
111
|
+
});
|
|
112
|
+
const api = new FeedbackApi(config);
|
|
107
113
|
|
|
108
114
|
const body = {
|
|
109
115
|
// FeedbackTargetType (optional)
|
|
@@ -116,10 +122,6 @@ async function example() {
|
|
|
116
122
|
limit: 56,
|
|
117
123
|
// number | Number of items to skip (optional)
|
|
118
124
|
offset: 56,
|
|
119
|
-
// string (optional)
|
|
120
|
-
authorization: authorization_example,
|
|
121
|
-
// string (optional)
|
|
122
|
-
ksUat: ksUat_example,
|
|
123
125
|
} satisfies ListFeedbackRequest;
|
|
124
126
|
|
|
125
127
|
try {
|
|
@@ -144,8 +146,6 @@ example().catch(console.error);
|
|
|
144
146
|
| **rating** | `FeedbackRating` | | [Optional] [Defaults to `undefined`] [Enum: UP, DOWN] |
|
|
145
147
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
146
148
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
147
|
-
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
148
|
-
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
149
149
|
|
|
150
150
|
### Return type
|
|
151
151
|
|
|
@@ -153,7 +153,7 @@ example().catch(console.error);
|
|
|
153
153
|
|
|
154
154
|
### Authorization
|
|
155
155
|
|
|
156
|
-
|
|
156
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
157
157
|
|
|
158
158
|
### HTTP request headers
|
|
159
159
|
|
|
@@ -172,7 +172,7 @@ No authorization required
|
|
|
172
172
|
|
|
173
173
|
## submitFeedback
|
|
174
174
|
|
|
175
|
-
> FeedbackEventResponse submitFeedback(submitFeedbackRequest
|
|
175
|
+
> FeedbackEventResponse submitFeedback(submitFeedbackRequest)
|
|
176
176
|
|
|
177
177
|
Submit Feedback Handler
|
|
178
178
|
|
|
@@ -189,15 +189,17 @@ import type { SubmitFeedbackOperationRequest } from '@knowledge-stack/ksapi';
|
|
|
189
189
|
|
|
190
190
|
async function example() {
|
|
191
191
|
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
192
|
-
const
|
|
192
|
+
const config = new Configuration({
|
|
193
|
+
// To configure API key authorization: cookieAuth
|
|
194
|
+
apiKey: "YOUR API KEY",
|
|
195
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
196
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
197
|
+
});
|
|
198
|
+
const api = new FeedbackApi(config);
|
|
193
199
|
|
|
194
200
|
const body = {
|
|
195
201
|
// SubmitFeedbackRequest
|
|
196
202
|
submitFeedbackRequest: ...,
|
|
197
|
-
// string (optional)
|
|
198
|
-
authorization: authorization_example,
|
|
199
|
-
// string (optional)
|
|
200
|
-
ksUat: ksUat_example,
|
|
201
203
|
} satisfies SubmitFeedbackOperationRequest;
|
|
202
204
|
|
|
203
205
|
try {
|
|
@@ -218,8 +220,6 @@ example().catch(console.error);
|
|
|
218
220
|
| Name | Type | Description | Notes |
|
|
219
221
|
|------------- | ------------- | ------------- | -------------|
|
|
220
222
|
| **submitFeedbackRequest** | [SubmitFeedbackRequest](SubmitFeedbackRequest.md) | | |
|
|
221
|
-
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
222
|
-
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
223
223
|
|
|
224
224
|
### Return type
|
|
225
225
|
|
|
@@ -227,7 +227,7 @@ example().catch(console.error);
|
|
|
227
227
|
|
|
228
228
|
### Authorization
|
|
229
229
|
|
|
230
|
-
|
|
230
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
231
231
|
|
|
232
232
|
### HTTP request headers
|
|
233
233
|
|
package/docs/FolderResponse.md
CHANGED
|
@@ -20,7 +20,7 @@ Name | Type
|
|
|
20
20
|
`createdAt` | Date
|
|
21
21
|
`updatedAt` | Date
|
|
22
22
|
`tags` | [Array<TagResponse>](TagResponse.md)
|
|
23
|
-
`
|
|
23
|
+
`permissions` | [ItemPermissions](ItemPermissions.md)
|
|
24
24
|
|
|
25
25
|
## Example
|
|
26
26
|
|
|
@@ -42,7 +42,7 @@ const example = {
|
|
|
42
42
|
"createdAt": null,
|
|
43
43
|
"updatedAt": null,
|
|
44
44
|
"tags": null,
|
|
45
|
-
"
|
|
45
|
+
"permissions": null,
|
|
46
46
|
} satisfies FolderResponse
|
|
47
47
|
|
|
48
48
|
console.log(example)
|