@knowledge-stack/ksapi 1.101.1 → 1.102.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 +60 -4
- package/README.md +41 -4
- package/dist/apis/ApiConnectionsApi.d.ts +225 -0
- package/dist/apis/ApiConnectionsApi.js +322 -0
- package/dist/apis/AuditEventsApi.d.ts +57 -1
- package/dist/apis/AuditEventsApi.js +65 -0
- package/dist/apis/AuthApi.d.ts +5 -5
- package/dist/apis/AuthApi.js +3 -2
- package/dist/apis/DocumentVersionsApi.d.ts +26 -5
- package/dist/apis/DocumentVersionsApi.js +23 -2
- package/dist/apis/DocumentsApi.d.ts +22 -1
- package/dist/apis/DocumentsApi.js +21 -0
- package/dist/apis/FeedbackApi.d.ts +19 -1
- package/dist/apis/FeedbackApi.js +18 -0
- package/dist/apis/FoldersApi.d.ts +27 -9
- package/dist/apis/FoldersApi.js +20 -2
- package/dist/apis/InvitesApi.d.ts +29 -5
- package/dist/apis/InvitesApi.js +26 -2
- package/dist/apis/PathPartsApi.d.ts +57 -1
- package/dist/apis/PathPartsApi.js +68 -0
- package/dist/apis/TagsApi.d.ts +22 -1
- package/dist/apis/TagsApi.js +21 -0
- package/dist/apis/TenantGroupsApi.d.ts +43 -1
- package/dist/apis/TenantGroupsApi.js +42 -0
- package/dist/apis/TenantsApi.d.ts +16 -1
- package/dist/apis/TenantsApi.js +15 -0
- package/dist/apis/ThreadMessagesApi.d.ts +7 -1
- package/dist/apis/ThreadMessagesApi.js +6 -0
- package/dist/apis/ThreadsApi.d.ts +22 -1
- package/dist/apis/ThreadsApi.js +21 -0
- package/dist/apis/TrashApi.d.ts +28 -1
- package/dist/apis/TrashApi.js +27 -0
- package/dist/apis/UserPermissionsApi.d.ts +10 -1
- package/dist/apis/UserPermissionsApi.js +9 -0
- package/dist/apis/WorkflowDefinitionsApi.d.ts +81 -1
- package/dist/apis/WorkflowDefinitionsApi.js +93 -0
- package/dist/apis/WorkflowRunsApi.d.ts +119 -1
- package/dist/apis/WorkflowRunsApi.js +136 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/ApiConnectionsApi.d.ts +225 -0
- package/dist/esm/apis/ApiConnectionsApi.js +285 -0
- package/dist/esm/apis/AuditEventsApi.d.ts +57 -1
- package/dist/esm/apis/AuditEventsApi.js +65 -0
- package/dist/esm/apis/AuthApi.d.ts +5 -5
- package/dist/esm/apis/AuthApi.js +4 -3
- package/dist/esm/apis/DocumentVersionsApi.d.ts +26 -5
- package/dist/esm/apis/DocumentVersionsApi.js +23 -2
- package/dist/esm/apis/DocumentsApi.d.ts +22 -1
- package/dist/esm/apis/DocumentsApi.js +21 -0
- package/dist/esm/apis/FeedbackApi.d.ts +19 -1
- package/dist/esm/apis/FeedbackApi.js +18 -0
- package/dist/esm/apis/FoldersApi.d.ts +27 -9
- package/dist/esm/apis/FoldersApi.js +21 -3
- package/dist/esm/apis/InvitesApi.d.ts +29 -5
- package/dist/esm/apis/InvitesApi.js +26 -2
- package/dist/esm/apis/PathPartsApi.d.ts +57 -1
- package/dist/esm/apis/PathPartsApi.js +69 -1
- package/dist/esm/apis/TagsApi.d.ts +22 -1
- package/dist/esm/apis/TagsApi.js +21 -0
- package/dist/esm/apis/TenantGroupsApi.d.ts +43 -1
- package/dist/esm/apis/TenantGroupsApi.js +42 -0
- package/dist/esm/apis/TenantsApi.d.ts +16 -1
- package/dist/esm/apis/TenantsApi.js +15 -0
- package/dist/esm/apis/ThreadMessagesApi.d.ts +7 -1
- package/dist/esm/apis/ThreadMessagesApi.js +6 -0
- package/dist/esm/apis/ThreadsApi.d.ts +22 -1
- package/dist/esm/apis/ThreadsApi.js +21 -0
- package/dist/esm/apis/TrashApi.d.ts +28 -1
- package/dist/esm/apis/TrashApi.js +27 -0
- package/dist/esm/apis/UserPermissionsApi.d.ts +10 -1
- package/dist/esm/apis/UserPermissionsApi.js +9 -0
- package/dist/esm/apis/WorkflowDefinitionsApi.d.ts +81 -1
- package/dist/esm/apis/WorkflowDefinitionsApi.js +94 -1
- package/dist/esm/apis/WorkflowRunsApi.d.ts +119 -1
- package/dist/esm/apis/WorkflowRunsApi.js +137 -1
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/AcceptDisclaimerRequest.d.ts +47 -0
- package/dist/esm/models/AcceptDisclaimerRequest.js +44 -0
- package/dist/esm/models/ApiAuthConfig.d.ts +56 -0
- package/dist/esm/models/ApiAuthConfig.js +55 -0
- package/dist/esm/models/ApiConnectionRequestRequest.d.ts +75 -0
- package/dist/esm/models/ApiConnectionRequestRequest.js +59 -0
- package/dist/esm/models/ApiConnectionRequestResponse.d.ts +73 -0
- package/dist/esm/models/ApiConnectionRequestResponse.js +60 -0
- package/dist/esm/models/ApiConnectionResponse.d.ts +163 -0
- package/dist/esm/models/ApiConnectionResponse.js +118 -0
- package/dist/esm/models/ApiKeyResponse.d.ts +12 -0
- package/dist/esm/models/ApiKeyResponse.js +8 -0
- package/dist/esm/models/CreateApiConnectionRequest.d.ts +85 -0
- package/dist/esm/models/CreateApiConnectionRequest.js +76 -0
- package/dist/esm/models/CreateApiKeyRequest.d.ts +6 -0
- package/dist/esm/models/CreateApiKeyRequest.js +2 -0
- package/dist/esm/models/CreateApiKeyResponse.d.ts +6 -0
- package/dist/esm/models/CreateApiKeyResponse.js +4 -0
- package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
- package/dist/esm/models/CreateWorkflowDefinitionRequest.js +2 -0
- package/dist/esm/models/DataSourceQueryResponse.d.ts +10 -0
- package/dist/esm/models/DataSourceQueryResponse.js +2 -0
- package/dist/esm/models/DataSourceResponse.d.ts +7 -0
- package/dist/esm/models/DataSourceResponse.js +3 -0
- package/dist/esm/models/DocumentResponse.d.ts +2 -2
- package/dist/esm/models/DocumentResponse.js +1 -3
- package/dist/esm/models/DocumentVersionOrder.d.ts +25 -0
- package/dist/esm/models/DocumentVersionOrder.js +43 -0
- package/dist/esm/models/ErrorResponse.d.ts +59 -0
- package/dist/esm/models/ErrorResponse.js +50 -0
- package/dist/esm/models/FeedbackOrder.d.ts +24 -0
- package/dist/esm/models/FeedbackOrder.js +42 -0
- package/dist/esm/models/FolderResponse.d.ts +7 -0
- package/dist/esm/models/FolderResponse.js +3 -0
- package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts} +9 -6
- package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.js} +11 -6
- package/dist/esm/models/GroupMemberOrder.d.ts +25 -0
- package/dist/esm/models/GroupMemberOrder.js +43 -0
- package/dist/esm/models/GroupPermissionOrder.d.ts +25 -0
- package/dist/esm/models/GroupPermissionOrder.js +43 -0
- package/dist/esm/models/InstantiateWorkflowTemplateRequest.d.ts +55 -0
- package/dist/esm/models/InstantiateWorkflowTemplateRequest.js +50 -0
- package/dist/esm/models/InviteOrder.d.ts +25 -0
- package/dist/esm/models/InviteOrder.js +43 -0
- package/dist/esm/models/InviteResponse.d.ts +6 -0
- package/dist/esm/models/InviteResponse.js +2 -0
- package/dist/esm/models/NetworkClass.d.ts +28 -0
- package/dist/esm/models/NetworkClass.js +46 -0
- package/dist/{models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.d.ts → esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts} +16 -16
- package/dist/esm/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js} +12 -12
- package/dist/esm/models/PartType.d.ts +1 -0
- package/dist/esm/models/PartType.js +2 -1
- package/dist/esm/models/ReferenceType.d.ts +1 -0
- package/dist/esm/models/ReferenceType.js +1 -0
- package/dist/esm/models/SortDirection.d.ts +25 -0
- package/dist/esm/models/SortDirection.js +43 -0
- package/dist/esm/models/TagOrder.d.ts +25 -0
- package/dist/esm/models/TagOrder.js +43 -0
- package/dist/esm/models/TenantGroupOrder.d.ts +25 -0
- package/dist/esm/models/TenantGroupOrder.js +43 -0
- package/dist/esm/models/TenantUserOrder.d.ts +26 -0
- package/dist/esm/models/TenantUserOrder.js +44 -0
- package/dist/esm/models/ThreadOrder.d.ts +25 -0
- package/dist/esm/models/ThreadOrder.js +43 -0
- package/dist/esm/models/ThreadResponse.d.ts +7 -0
- package/dist/esm/models/ThreadResponse.js +3 -0
- package/dist/esm/models/TransferOwnerRequest.d.ts +47 -0
- package/dist/esm/models/TransferOwnerRequest.js +44 -0
- package/dist/esm/models/TransferOwnerResponse.d.ts +53 -0
- package/dist/esm/models/TransferOwnerResponse.js +48 -0
- package/dist/esm/models/TrashItemResponse.d.ts +7 -0
- package/dist/esm/models/TrashItemResponse.js +3 -0
- package/dist/esm/models/UpdateApiConnectionRequest.d.ts +73 -0
- package/dist/esm/models/UpdateApiConnectionRequest.js +59 -0
- package/dist/esm/models/UserPermissionOrder.d.ts +25 -0
- package/dist/esm/models/UserPermissionOrder.js +43 -0
- package/dist/esm/models/WorkflowAdoptionStats.d.ts +63 -0
- package/dist/esm/models/WorkflowAdoptionStats.js +52 -0
- package/dist/esm/models/WorkflowDefinitionOrder.d.ts +25 -0
- package/dist/esm/models/WorkflowDefinitionOrder.js +43 -0
- package/dist/esm/models/WorkflowDefinitionResponse.d.ts +25 -0
- package/dist/esm/models/WorkflowDefinitionResponse.js +13 -0
- package/dist/esm/models/WorkflowRunOrder.d.ts +26 -0
- package/dist/esm/models/WorkflowRunOrder.js +44 -0
- package/dist/esm/models/WorkflowRunResponse.d.ts +6 -0
- package/dist/esm/models/WorkflowRunResponse.js +2 -0
- package/dist/esm/models/WorkflowRunSummaryResponse.d.ts +111 -0
- package/dist/esm/models/WorkflowRunSummaryResponse.js +81 -0
- package/dist/esm/models/index.d.ts +29 -2
- package/dist/esm/models/index.js +29 -2
- package/dist/models/AcceptDisclaimerRequest.d.ts +47 -0
- package/dist/models/AcceptDisclaimerRequest.js +52 -0
- package/dist/models/ApiAuthConfig.d.ts +56 -0
- package/dist/models/ApiAuthConfig.js +63 -0
- package/dist/models/ApiConnectionRequestRequest.d.ts +75 -0
- package/dist/models/ApiConnectionRequestRequest.js +67 -0
- package/dist/models/ApiConnectionRequestResponse.d.ts +73 -0
- package/dist/models/ApiConnectionRequestResponse.js +68 -0
- package/dist/models/ApiConnectionResponse.d.ts +163 -0
- package/dist/models/ApiConnectionResponse.js +126 -0
- package/dist/models/ApiKeyResponse.d.ts +12 -0
- package/dist/models/ApiKeyResponse.js +8 -0
- package/dist/models/CreateApiConnectionRequest.d.ts +85 -0
- package/dist/models/CreateApiConnectionRequest.js +84 -0
- package/dist/models/CreateApiKeyRequest.d.ts +6 -0
- package/dist/models/CreateApiKeyRequest.js +2 -0
- package/dist/models/CreateApiKeyResponse.d.ts +6 -0
- package/dist/models/CreateApiKeyResponse.js +4 -0
- package/dist/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
- package/dist/models/CreateWorkflowDefinitionRequest.js +2 -0
- package/dist/models/DataSourceQueryResponse.d.ts +10 -0
- package/dist/models/DataSourceQueryResponse.js +2 -0
- package/dist/models/DataSourceResponse.d.ts +7 -0
- package/dist/models/DataSourceResponse.js +3 -0
- package/dist/models/DocumentResponse.d.ts +2 -2
- package/dist/models/DocumentResponse.js +1 -3
- package/dist/models/DocumentVersionOrder.d.ts +25 -0
- package/dist/models/DocumentVersionOrder.js +51 -0
- package/dist/models/ErrorResponse.d.ts +59 -0
- package/dist/models/ErrorResponse.js +58 -0
- package/dist/models/FeedbackOrder.d.ts +24 -0
- package/dist/models/FeedbackOrder.js +50 -0
- package/dist/models/FolderResponse.d.ts +7 -0
- package/dist/models/FolderResponse.js +3 -0
- package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts} +9 -6
- package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.js} +15 -10
- package/dist/models/GroupMemberOrder.d.ts +25 -0
- package/dist/models/GroupMemberOrder.js +51 -0
- package/dist/models/GroupPermissionOrder.d.ts +25 -0
- package/dist/models/GroupPermissionOrder.js +51 -0
- package/dist/models/InstantiateWorkflowTemplateRequest.d.ts +55 -0
- package/dist/models/InstantiateWorkflowTemplateRequest.js +58 -0
- package/dist/models/InviteOrder.d.ts +25 -0
- package/dist/models/InviteOrder.js +51 -0
- package/dist/models/InviteResponse.d.ts +6 -0
- package/dist/models/InviteResponse.js +2 -0
- package/dist/models/NetworkClass.d.ts +28 -0
- package/dist/models/NetworkClass.js +54 -0
- package/dist/{esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.d.ts → models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts} +16 -16
- package/dist/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js} +18 -18
- package/dist/models/PartType.d.ts +1 -0
- package/dist/models/PartType.js +2 -1
- package/dist/models/ReferenceType.d.ts +1 -0
- package/dist/models/ReferenceType.js +1 -0
- package/dist/models/SortDirection.d.ts +25 -0
- package/dist/models/SortDirection.js +51 -0
- package/dist/models/TagOrder.d.ts +25 -0
- package/dist/models/TagOrder.js +51 -0
- package/dist/models/TenantGroupOrder.d.ts +25 -0
- package/dist/models/TenantGroupOrder.js +51 -0
- package/dist/models/TenantUserOrder.d.ts +26 -0
- package/dist/models/TenantUserOrder.js +52 -0
- package/dist/models/ThreadOrder.d.ts +25 -0
- package/dist/models/ThreadOrder.js +51 -0
- package/dist/models/ThreadResponse.d.ts +7 -0
- package/dist/models/ThreadResponse.js +3 -0
- package/dist/models/TransferOwnerRequest.d.ts +47 -0
- package/dist/models/TransferOwnerRequest.js +52 -0
- package/dist/models/TransferOwnerResponse.d.ts +53 -0
- package/dist/models/TransferOwnerResponse.js +56 -0
- package/dist/models/TrashItemResponse.d.ts +7 -0
- package/dist/models/TrashItemResponse.js +3 -0
- package/dist/models/UpdateApiConnectionRequest.d.ts +73 -0
- package/dist/models/UpdateApiConnectionRequest.js +67 -0
- package/dist/models/UserPermissionOrder.d.ts +25 -0
- package/dist/models/UserPermissionOrder.js +51 -0
- package/dist/models/WorkflowAdoptionStats.d.ts +63 -0
- package/dist/models/WorkflowAdoptionStats.js +60 -0
- package/dist/models/WorkflowDefinitionOrder.d.ts +25 -0
- package/dist/models/WorkflowDefinitionOrder.js +51 -0
- package/dist/models/WorkflowDefinitionResponse.d.ts +25 -0
- package/dist/models/WorkflowDefinitionResponse.js +13 -0
- package/dist/models/WorkflowRunOrder.d.ts +26 -0
- package/dist/models/WorkflowRunOrder.js +52 -0
- package/dist/models/WorkflowRunResponse.d.ts +6 -0
- package/dist/models/WorkflowRunResponse.js +2 -0
- package/dist/models/WorkflowRunSummaryResponse.d.ts +111 -0
- package/dist/models/WorkflowRunSummaryResponse.js +89 -0
- package/dist/models/index.d.ts +29 -2
- package/dist/models/index.js +29 -2
- package/docs/AcceptDisclaimerRequest.md +35 -0
- package/docs/AgentApi.md +2 -0
- package/docs/ApiAuthConfig.md +37 -0
- package/docs/ApiConnectionRequestRequest.md +43 -0
- package/docs/ApiConnectionRequestResponse.md +43 -0
- package/docs/ApiConnectionResponse.md +69 -0
- package/docs/ApiConnectionsApi.md +397 -0
- package/docs/ApiKeyResponse.md +4 -0
- package/docs/ApiKeysApi.md +4 -0
- package/docs/AuditEventsApi.md +96 -1
- package/docs/AuthApi.md +20 -2
- package/docs/ChunkLineagesApi.md +3 -0
- package/docs/ChunksApi.md +10 -1
- package/docs/CreateApiConnectionRequest.md +47 -0
- package/docs/CreateApiKeyRequest.md +2 -0
- package/docs/CreateApiKeyResponse.md +2 -0
- package/docs/CreateWorkflowDefinitionRequest.md +2 -0
- package/docs/DataSourceQueryResponse.md +3 -1
- package/docs/DataSourceResponse.md +2 -0
- package/docs/DataSourcesApi.md +7 -0
- package/docs/DefaultApi.md +2 -0
- package/docs/DocumentCheckoutApi.md +3 -0
- package/docs/DocumentVersionOrder.md +33 -0
- package/docs/DocumentVersionsApi.md +33 -2
- package/docs/DocumentsApi.md +30 -1
- package/docs/ErrorResponse.md +39 -0
- package/docs/FeaturesApi.md +1 -0
- package/docs/FeedbackApi.md +22 -1
- package/docs/FeedbackOrder.md +33 -0
- package/docs/FolderResponse.md +2 -0
- package/docs/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.md → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.md} +24 -6
- package/docs/FoldersApi.md +31 -5
- package/docs/GroupMemberOrder.md +33 -0
- package/docs/GroupPermissionOrder.md +33 -0
- package/docs/InstantiateWorkflowTemplateRequest.md +37 -0
- package/docs/InviteOrder.md +33 -0
- package/docs/InviteResponse.md +2 -0
- package/docs/InvitesApi.md +31 -2
- package/docs/MemoryApi.md +5 -0
- package/docs/NetworkClass.md +33 -0
- package/docs/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.md → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md} +5 -5
- package/docs/PathPartApprovalsApi.md +2 -0
- package/docs/PathPartsApi.md +105 -1
- package/docs/PublicApi.md +1 -0
- package/docs/SectionsApi.md +6 -0
- package/docs/SortDirection.md +33 -0
- package/docs/SubscriptionsApi.md +2 -0
- package/docs/TagOrder.md +33 -0
- package/docs/TagsApi.md +27 -1
- package/docs/TenantGroupOrder.md +33 -0
- package/docs/TenantGroupsApi.md +58 -3
- package/docs/TenantUserOrder.md +33 -0
- package/docs/TenantsApi.md +28 -1
- package/docs/ThreadMessagesApi.md +10 -1
- package/docs/ThreadOrder.md +33 -0
- package/docs/ThreadResponse.md +2 -0
- package/docs/ThreadsApi.md +29 -1
- package/docs/TransferOwnerRequest.md +35 -0
- package/docs/TransferOwnerResponse.md +36 -0
- package/docs/TrashApi.md +31 -1
- package/docs/TrashItemResponse.md +2 -0
- package/docs/UpdateApiConnectionRequest.md +43 -0
- package/docs/UserPermissionOrder.md +33 -0
- package/docs/UserPermissionsApi.md +14 -1
- package/docs/UsersApi.md +5 -0
- package/docs/WorkflowAdoptionStats.md +39 -0
- package/docs/WorkflowDefinitionOrder.md +33 -0
- package/docs/WorkflowDefinitionResponse.md +8 -0
- package/docs/WorkflowDefinitionsApi.md +128 -2
- package/docs/WorkflowMemoryApi.md +5 -0
- package/docs/WorkflowRunOrder.md +33 -0
- package/docs/WorkflowRunResponse.md +2 -0
- package/docs/WorkflowRunSummaryResponse.md +53 -0
- package/docs/WorkflowRunsApi.md +203 -0
- package/docs/WorkflowsApi.md +5 -0
- package/package.json +1 -1
- package/src/apis/AgentApi.ts +3 -0
- package/src/apis/ApiConnectionsApi.ts +516 -0
- package/src/apis/ApiKeysApi.ts +3 -0
- package/src/apis/AuditEventsApi.ts +127 -0
- package/src/apis/AuthApi.ts +10 -6
- package/src/apis/ChunkLineagesApi.ts +3 -0
- package/src/apis/ChunksApi.ts +3 -0
- package/src/apis/DataSourcesApi.ts +3 -0
- package/src/apis/DefaultApi.ts +3 -0
- package/src/apis/DocumentCheckoutApi.ts +3 -0
- package/src/apis/DocumentVersionsApi.ts +62 -4
- package/src/apis/DocumentsApi.ts +58 -0
- package/src/apis/FeaturesApi.ts +3 -0
- package/src/apis/FeedbackApi.ts +51 -0
- package/src/apis/FoldersApi.ts +61 -13
- package/src/apis/InvitesApi.ts +72 -4
- package/src/apis/MemoryApi.ts +3 -0
- package/src/apis/PathPartApprovalsApi.ts +3 -0
- package/src/apis/PathPartsApi.ts +143 -0
- package/src/apis/PublicApi.ts +3 -0
- package/src/apis/SectionsApi.ts +3 -0
- package/src/apis/SubscriptionsApi.ts +3 -0
- package/src/apis/TagsApi.ts +58 -0
- package/src/apis/TenantGroupsApi.ts +116 -0
- package/src/apis/TenantsApi.ts +47 -0
- package/src/apis/ThreadMessagesApi.ts +23 -0
- package/src/apis/ThreadsApi.ts +58 -0
- package/src/apis/TrashApi.ts +75 -0
- package/src/apis/UserPermissionsApi.ts +33 -0
- package/src/apis/UsersApi.ts +3 -0
- package/src/apis/WorkflowDefinitionsApi.ts +206 -0
- package/src/apis/WorkflowMemoryApi.ts +3 -0
- package/src/apis/WorkflowRunsApi.ts +274 -0
- package/src/apis/WorkflowsApi.ts +3 -0
- package/src/apis/index.ts +1 -0
- package/src/models/AcceptDisclaimerRequest.ts +83 -0
- package/src/models/ApiAuthConfig.ts +101 -0
- package/src/models/ApiConnectionRequestRequest.ts +121 -0
- package/src/models/ApiConnectionRequestResponse.ts +119 -0
- package/src/models/ApiConnectionResponse.ts +276 -0
- package/src/models/ApiKeyResponse.ts +18 -0
- package/src/models/CreateApiConnectionRequest.ts +161 -0
- package/src/models/CreateApiKeyRequest.ts +8 -0
- package/src/models/CreateApiKeyResponse.ts +9 -0
- package/src/models/CreateWorkflowDefinitionRequest.ts +8 -0
- package/src/models/DataSourceQueryResponse.ts +12 -0
- package/src/models/DataSourceResponse.ts +15 -0
- package/src/models/DocumentResponse.ts +3 -4
- package/src/models/DocumentVersionOrder.ts +53 -0
- package/src/models/ErrorResponse.ts +100 -0
- package/src/models/FeedbackOrder.ts +52 -0
- package/src/models/FolderResponse.ts +15 -0
- package/src/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.ts} +19 -8
- package/src/models/GroupMemberOrder.ts +53 -0
- package/src/models/GroupPermissionOrder.ts +53 -0
- package/src/models/InstantiateWorkflowTemplateRequest.ts +96 -0
- package/src/models/InviteOrder.ts +53 -0
- package/src/models/InviteResponse.ts +8 -0
- package/src/models/NetworkClass.ts +56 -0
- package/src/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.ts} +25 -25
- package/src/models/PartType.ts +2 -1
- package/src/models/ReferenceType.ts +1 -0
- package/src/models/SortDirection.ts +53 -0
- package/src/models/TagOrder.ts +53 -0
- package/src/models/TenantGroupOrder.ts +53 -0
- package/src/models/TenantUserOrder.ts +54 -0
- package/src/models/ThreadOrder.ts +53 -0
- package/src/models/ThreadResponse.ts +16 -0
- package/src/models/TransferOwnerRequest.ts +83 -0
- package/src/models/TransferOwnerResponse.ts +92 -0
- package/src/models/TrashItemResponse.ts +15 -0
- package/src/models/UpdateApiConnectionRequest.ts +137 -0
- package/src/models/UserPermissionOrder.ts +53 -0
- package/src/models/WorkflowAdoptionStats.ts +105 -0
- package/src/models/WorkflowDefinitionOrder.ts +53 -0
- package/src/models/WorkflowDefinitionResponse.ts +41 -0
- package/src/models/WorkflowRunOrder.ts +54 -0
- package/src/models/WorkflowRunResponse.ts +8 -0
- package/src/models/WorkflowRunSummaryResponse.ts +179 -0
- package/src/models/index.ts +29 -2
package/docs/InviteResponse.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type
|
|
|
16
16
|
`acceptedAt` | Date
|
|
17
17
|
`createdAt` | Date
|
|
18
18
|
`updatedAt` | Date
|
|
19
|
+
`invitedByUserId` | string
|
|
19
20
|
`inviteLink` | string
|
|
20
21
|
`emailId` | string
|
|
21
22
|
|
|
@@ -35,6 +36,7 @@ const example = {
|
|
|
35
36
|
"acceptedAt": null,
|
|
36
37
|
"createdAt": null,
|
|
37
38
|
"updatedAt": null,
|
|
39
|
+
"invitedByUserId": null,
|
|
38
40
|
"inviteLink": null,
|
|
39
41
|
"emailId": null,
|
|
40
42
|
} satisfies InviteResponse
|
package/docs/InvitesApi.md
CHANGED
|
@@ -82,6 +82,7 @@ example().catch(console.error);
|
|
|
82
82
|
|-------------|-------------|------------------|
|
|
83
83
|
| **200** | Successful Response | - |
|
|
84
84
|
| **422** | Validation Error | - |
|
|
85
|
+
| **0** | Error response. | - |
|
|
85
86
|
|
|
86
87
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
87
88
|
|
|
@@ -156,6 +157,7 @@ example().catch(console.error);
|
|
|
156
157
|
|-------------|-------------|------------------|
|
|
157
158
|
| **201** | Successful Response | - |
|
|
158
159
|
| **422** | Validation Error | - |
|
|
160
|
+
| **0** | Error response. | - |
|
|
159
161
|
|
|
160
162
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
161
163
|
|
|
@@ -230,17 +232,18 @@ example().catch(console.error);
|
|
|
230
232
|
|-------------|-------------|------------------|
|
|
231
233
|
| **204** | Successful Response | - |
|
|
232
234
|
| **422** | Validation Error | - |
|
|
235
|
+
| **0** | Error response. | - |
|
|
233
236
|
|
|
234
237
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
235
238
|
|
|
236
239
|
|
|
237
240
|
## listInvites
|
|
238
241
|
|
|
239
|
-
> PaginatedResponseInviteResponse listInvites(email, status, limit, offset)
|
|
242
|
+
> PaginatedResponseInviteResponse listInvites(email, status, role, invitedBy, sortBy, sortDir, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
|
|
240
243
|
|
|
241
244
|
List Invites Handler
|
|
242
245
|
|
|
243
|
-
List invites with pagination, filtering, and sorting. Supports filtering by
|
|
246
|
+
List invites with pagination, filtering, and sorting. Supports filtering by email, status, role, and a created_at/updated_at timestamp range. Results sort by created_at (ascending) by default.
|
|
244
247
|
|
|
245
248
|
### Example
|
|
246
249
|
|
|
@@ -266,10 +269,26 @@ async function example() {
|
|
|
266
269
|
email: email_example,
|
|
267
270
|
// InviteStatus | Filter by invite status (pending, accepted, expired) (optional)
|
|
268
271
|
status: ...,
|
|
272
|
+
// TenantUserRole | Filter by invite role (optional)
|
|
273
|
+
role: ...,
|
|
274
|
+
// string | Filter to invites sent by this user (optional)
|
|
275
|
+
invitedBy: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
276
|
+
// InviteOrder | Field to sort invites by (default: CREATED_AT) (optional)
|
|
277
|
+
sortBy: ...,
|
|
278
|
+
// SortDirection | Sort direction; overrides the field\'s natural default (optional)
|
|
279
|
+
sortDir: ...,
|
|
269
280
|
// number | Number of items per page (optional)
|
|
270
281
|
limit: 56,
|
|
271
282
|
// number | Number of items to skip (optional)
|
|
272
283
|
offset: 56,
|
|
284
|
+
// Date | Only items created at or after this timestamp (inclusive) (optional)
|
|
285
|
+
createdAfter: 2013-10-20T19:20:30+01:00,
|
|
286
|
+
// Date | Only items created strictly before this timestamp (optional)
|
|
287
|
+
createdBefore: 2013-10-20T19:20:30+01:00,
|
|
288
|
+
// Date | Only items updated at or after this timestamp (inclusive) (optional)
|
|
289
|
+
updatedAfter: 2013-10-20T19:20:30+01:00,
|
|
290
|
+
// Date | Only items updated strictly before this timestamp (optional)
|
|
291
|
+
updatedBefore: 2013-10-20T19:20:30+01:00,
|
|
273
292
|
} satisfies ListInvitesRequest;
|
|
274
293
|
|
|
275
294
|
try {
|
|
@@ -291,8 +310,16 @@ example().catch(console.error);
|
|
|
291
310
|
|------------- | ------------- | ------------- | -------------|
|
|
292
311
|
| **email** | `string` | Filter by email (case-insensitive partial match) | [Optional] [Defaults to `undefined`] |
|
|
293
312
|
| **status** | `InviteStatus` | Filter by invite status (pending, accepted, expired) | [Optional] [Defaults to `undefined`] [Enum: pending, accepted, expired] |
|
|
313
|
+
| **role** | `TenantUserRole` | Filter by invite role | [Optional] [Defaults to `undefined`] [Enum: USER, OWNER, ADMIN] |
|
|
314
|
+
| **invitedBy** | `string` | Filter to invites sent by this user | [Optional] [Defaults to `undefined`] |
|
|
315
|
+
| **sortBy** | `InviteOrder` | Field to sort invites by (default: CREATED_AT) | [Optional] [Defaults to `undefined`] [Enum: CREATED_AT, EXPIRES_AT] |
|
|
316
|
+
| **sortDir** | `SortDirection` | Sort direction; overrides the field\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
|
|
294
317
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
295
318
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
319
|
+
| **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
320
|
+
| **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
321
|
+
| **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
322
|
+
| **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
296
323
|
|
|
297
324
|
### Return type
|
|
298
325
|
|
|
@@ -313,6 +340,7 @@ example().catch(console.error);
|
|
|
313
340
|
|-------------|-------------|------------------|
|
|
314
341
|
| **200** | Successful Response | - |
|
|
315
342
|
| **422** | Validation Error | - |
|
|
343
|
+
| **0** | Error response. | - |
|
|
316
344
|
|
|
317
345
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
318
346
|
|
|
@@ -390,6 +418,7 @@ example().catch(console.error);
|
|
|
390
418
|
|-------------|-------------|------------------|
|
|
391
419
|
| **200** | Successful Response | - |
|
|
392
420
|
| **422** | Validation Error | - |
|
|
421
|
+
| **0** | Error response. | - |
|
|
393
422
|
|
|
394
423
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
395
424
|
|
package/docs/MemoryApi.md
CHANGED
|
@@ -80,6 +80,7 @@ example().catch(console.error);
|
|
|
80
80
|
|-------------|-------------|------------------|
|
|
81
81
|
| **200** | Successful Response | - |
|
|
82
82
|
| **422** | Validation Error | - |
|
|
83
|
+
| **0** | Error response. | - |
|
|
83
84
|
|
|
84
85
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
85
86
|
|
|
@@ -155,6 +156,7 @@ example().catch(console.error);
|
|
|
155
156
|
|-------------|-------------|------------------|
|
|
156
157
|
| **200** | Successful Response | - |
|
|
157
158
|
| **422** | Validation Error | - |
|
|
159
|
+
| **0** | Error response. | - |
|
|
158
160
|
|
|
159
161
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
160
162
|
|
|
@@ -230,6 +232,7 @@ example().catch(console.error);
|
|
|
230
232
|
|-------------|-------------|------------------|
|
|
231
233
|
| **200** | Successful Response | - |
|
|
232
234
|
| **422** | Validation Error | - |
|
|
235
|
+
| **0** | Error response. | - |
|
|
233
236
|
|
|
234
237
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
235
238
|
|
|
@@ -302,6 +305,7 @@ example().catch(console.error);
|
|
|
302
305
|
|-------------|-------------|------------------|
|
|
303
306
|
| **201** | Successful Response | - |
|
|
304
307
|
| **422** | Validation Error | - |
|
|
308
|
+
| **0** | Error response. | - |
|
|
305
309
|
|
|
306
310
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
307
311
|
|
|
@@ -374,6 +378,7 @@ example().catch(console.error);
|
|
|
374
378
|
|-------------|-------------|------------------|
|
|
375
379
|
| **204** | Successful Response | - |
|
|
376
380
|
| **422** | Validation Error | - |
|
|
381
|
+
| **0** | Error response. | - |
|
|
377
382
|
|
|
378
383
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
379
384
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# NetworkClass
|
|
3
|
+
|
|
4
|
+
Egress reachability class for an API connection. PUBLIC is SSRF-guarded (private/internal ranges blocked); INTERNAL allows private/cluster targets and bypasses the range check.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { NetworkClass } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies NetworkClass
|
|
19
|
+
|
|
20
|
+
console.log(example)
|
|
21
|
+
|
|
22
|
+
// Convert the instance to a JSON string
|
|
23
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
24
|
+
console.log(exampleJSON)
|
|
25
|
+
|
|
26
|
+
// Parse the JSON string back to an object
|
|
27
|
+
const exampleParsed = JSON.parse(exampleJSON) as NetworkClass
|
|
28
|
+
console.log(exampleParsed)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
32
|
+
|
|
33
|
+
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`items` | [Array<
|
|
9
|
+
`items` | [Array<FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse>](FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.md)
|
|
10
10
|
`total` | number
|
|
11
11
|
`limit` | number
|
|
12
12
|
`offset` | number
|
|
@@ -14,7 +14,7 @@ Name | Type
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
16
16
|
```typescript
|
|
17
|
-
import type {
|
|
17
|
+
import type { PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator } from '@knowledge-stack/ksapi'
|
|
18
18
|
|
|
19
19
|
// TODO: Update the object below with actual values
|
|
20
20
|
const example = {
|
|
@@ -22,7 +22,7 @@ const example = {
|
|
|
22
22
|
"total": null,
|
|
23
23
|
"limit": null,
|
|
24
24
|
"offset": null,
|
|
25
|
-
} satisfies
|
|
25
|
+
} satisfies PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator
|
|
26
26
|
|
|
27
27
|
console.log(example)
|
|
28
28
|
|
|
@@ -31,7 +31,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
31
31
|
console.log(exampleJSON)
|
|
32
32
|
|
|
33
33
|
// Parse the JSON string back to an object
|
|
34
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator
|
|
35
35
|
console.log(exampleParsed)
|
|
36
36
|
```
|
|
37
37
|
|
|
@@ -79,6 +79,7 @@ example().catch(console.error);
|
|
|
79
79
|
|-------------|-------------|------------------|
|
|
80
80
|
| **200** | Successful Response | - |
|
|
81
81
|
| **422** | Validation Error | - |
|
|
82
|
+
| **0** | Error response. | - |
|
|
82
83
|
|
|
83
84
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
84
85
|
|
|
@@ -156,6 +157,7 @@ example().catch(console.error);
|
|
|
156
157
|
|-------------|-------------|------------------|
|
|
157
158
|
| **200** | Successful Response | - |
|
|
158
159
|
| **422** | Validation Error | - |
|
|
160
|
+
| **0** | Error response. | - |
|
|
159
161
|
|
|
160
162
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
161
163
|
|
package/docs/PathPartsApi.md
CHANGED
|
@@ -14,6 +14,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
14
14
|
| [**listPathPartEvents**](PathPartsApi.md#listpathpartevents) | **GET** /v1/path-parts/{path_part_id}/events | List Path Part Events Handler |
|
|
15
15
|
| [**listPathParts**](PathPartsApi.md#listpathparts) | **GET** /v1/path-parts | List Path Parts Handler |
|
|
16
16
|
| [**setPathPartTags**](PathPartsApi.md#setpathparttags) | **POST** /v1/path-parts/{path_part_id}/tags | Set Path Part Tags Handler |
|
|
17
|
+
| [**transferPathPartOwner**](PathPartsApi.md#transferpathpartowner) | **PUT** /v1/path-parts/{path_part_id}/owner | Transfer Path Part Owner Handler |
|
|
17
18
|
|
|
18
19
|
|
|
19
20
|
|
|
@@ -90,6 +91,7 @@ example().catch(console.error);
|
|
|
90
91
|
|-------------|-------------|------------------|
|
|
91
92
|
| **201** | Successful Response | - |
|
|
92
93
|
| **422** | Validation Error | - |
|
|
94
|
+
| **0** | Error response. | - |
|
|
93
95
|
|
|
94
96
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
95
97
|
|
|
@@ -167,6 +169,7 @@ example().catch(console.error);
|
|
|
167
169
|
|-------------|-------------|------------------|
|
|
168
170
|
| **200** | Successful Response | - |
|
|
169
171
|
| **422** | Validation Error | - |
|
|
172
|
+
| **0** | Error response. | - |
|
|
170
173
|
|
|
171
174
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
172
175
|
|
|
@@ -247,6 +250,7 @@ example().catch(console.error);
|
|
|
247
250
|
|-------------|-------------|------------------|
|
|
248
251
|
| **200** | Successful Response | - |
|
|
249
252
|
| **422** | Validation Error | - |
|
|
253
|
+
| **0** | Error response. | - |
|
|
250
254
|
|
|
251
255
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
252
256
|
|
|
@@ -321,6 +325,7 @@ example().catch(console.error);
|
|
|
321
325
|
|-------------|-------------|------------------|
|
|
322
326
|
| **200** | Successful Response | - |
|
|
323
327
|
| **422** | Validation Error | - |
|
|
328
|
+
| **0** | Error response. | - |
|
|
324
329
|
|
|
325
330
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
326
331
|
|
|
@@ -395,6 +400,7 @@ example().catch(console.error);
|
|
|
395
400
|
|-------------|-------------|------------------|
|
|
396
401
|
| **200** | Successful Response | - |
|
|
397
402
|
| **422** | Validation Error | - |
|
|
403
|
+
| **0** | Error response. | - |
|
|
398
404
|
|
|
399
405
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
400
406
|
|
|
@@ -469,6 +475,7 @@ example().catch(console.error);
|
|
|
469
475
|
|-------------|-------------|------------------|
|
|
470
476
|
| **200** | Successful Response | - |
|
|
471
477
|
| **422** | Validation Error | - |
|
|
478
|
+
| **0** | Error response. | - |
|
|
472
479
|
|
|
473
480
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
474
481
|
|
|
@@ -546,6 +553,7 @@ example().catch(console.error);
|
|
|
546
553
|
|-------------|-------------|------------------|
|
|
547
554
|
| **200** | Successful Response | - |
|
|
548
555
|
| **422** | Validation Error | - |
|
|
556
|
+
| **0** | Error response. | - |
|
|
549
557
|
|
|
550
558
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
551
559
|
|
|
@@ -638,13 +646,14 @@ example().catch(console.error);
|
|
|
638
646
|
|-------------|-------------|------------------|
|
|
639
647
|
| **200** | Successful Response | - |
|
|
640
648
|
| **422** | Validation Error | - |
|
|
649
|
+
| **0** | Error response. | - |
|
|
641
650
|
|
|
642
651
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
643
652
|
|
|
644
653
|
|
|
645
654
|
## listPathParts
|
|
646
655
|
|
|
647
|
-
> PaginatedResponsePathPartResponse listPathParts(parentPathId, maxDepth, sortOrder, limit, offset)
|
|
656
|
+
> PaginatedResponsePathPartResponse listPathParts(parentPathId, maxDepth, sortOrder, sortDir, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
|
|
648
657
|
|
|
649
658
|
List Path Parts Handler
|
|
650
659
|
|
|
@@ -676,10 +685,20 @@ async function example() {
|
|
|
676
685
|
maxDepth: 56,
|
|
677
686
|
// PathOrder | Sort order for results (default: LOGICAL) (optional)
|
|
678
687
|
sortOrder: ...,
|
|
688
|
+
// SortDirection | Sort direction; overrides the column\'s natural default (optional)
|
|
689
|
+
sortDir: ...,
|
|
679
690
|
// number | Number of items per page (optional)
|
|
680
691
|
limit: 56,
|
|
681
692
|
// number | Number of items to skip (optional)
|
|
682
693
|
offset: 56,
|
|
694
|
+
// Date | Only items created at or after this timestamp (inclusive) (optional)
|
|
695
|
+
createdAfter: 2013-10-20T19:20:30+01:00,
|
|
696
|
+
// Date | Only items created strictly before this timestamp (optional)
|
|
697
|
+
createdBefore: 2013-10-20T19:20:30+01:00,
|
|
698
|
+
// Date | Only items updated at or after this timestamp (inclusive) (optional)
|
|
699
|
+
updatedAfter: 2013-10-20T19:20:30+01:00,
|
|
700
|
+
// Date | Only items updated strictly before this timestamp (optional)
|
|
701
|
+
updatedBefore: 2013-10-20T19:20:30+01:00,
|
|
683
702
|
} satisfies ListPathPartsRequest;
|
|
684
703
|
|
|
685
704
|
try {
|
|
@@ -702,8 +721,13 @@ example().catch(console.error);
|
|
|
702
721
|
| **parentPathId** | `string` | Parent PathPart ID (defaults to root) | [Optional] [Defaults to `undefined`] |
|
|
703
722
|
| **maxDepth** | `number` | Maximum depth to traverse (1 = direct children, default: 1) | [Optional] [Defaults to `1`] |
|
|
704
723
|
| **sortOrder** | `PathOrder` | Sort order for results (default: LOGICAL) | [Optional] [Defaults to `undefined`] [Enum: LOGICAL, NAME, UPDATED_AT, CREATED_AT] |
|
|
724
|
+
| **sortDir** | `SortDirection` | Sort direction; overrides the column\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
|
|
705
725
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
706
726
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
727
|
+
| **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
728
|
+
| **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
729
|
+
| **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
730
|
+
| **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
707
731
|
|
|
708
732
|
### Return type
|
|
709
733
|
|
|
@@ -724,6 +748,7 @@ example().catch(console.error);
|
|
|
724
748
|
|-------------|-------------|------------------|
|
|
725
749
|
| **200** | Successful Response | - |
|
|
726
750
|
| **422** | Validation Error | - |
|
|
751
|
+
| **0** | Error response. | - |
|
|
727
752
|
|
|
728
753
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
729
754
|
|
|
@@ -801,6 +826,85 @@ example().catch(console.error);
|
|
|
801
826
|
|-------------|-------------|------------------|
|
|
802
827
|
| **200** | Successful Response | - |
|
|
803
828
|
| **422** | Validation Error | - |
|
|
829
|
+
| **0** | Error response. | - |
|
|
830
|
+
|
|
831
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
## transferPathPartOwner
|
|
835
|
+
|
|
836
|
+
> TransferOwnerResponse transferPathPartOwner(pathPartId, transferOwnerRequest)
|
|
837
|
+
|
|
838
|
+
Transfer Path Part Owner Handler
|
|
839
|
+
|
|
840
|
+
Transfer ownership of a shared path_part to another tenant member. Allowed for the current owner or a tenant ADMIN/OWNER. Personal items (under /users/{uid}) and system-managed items cannot be transferred.
|
|
841
|
+
|
|
842
|
+
### Example
|
|
843
|
+
|
|
844
|
+
```ts
|
|
845
|
+
import {
|
|
846
|
+
Configuration,
|
|
847
|
+
PathPartsApi,
|
|
848
|
+
} from '@knowledge-stack/ksapi';
|
|
849
|
+
import type { TransferPathPartOwnerRequest } from '@knowledge-stack/ksapi';
|
|
850
|
+
|
|
851
|
+
async function example() {
|
|
852
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
853
|
+
const config = new Configuration({
|
|
854
|
+
// To configure API key authorization: cookieAuth
|
|
855
|
+
apiKey: "YOUR API KEY",
|
|
856
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
857
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
858
|
+
});
|
|
859
|
+
const api = new PathPartsApi(config);
|
|
860
|
+
|
|
861
|
+
const body = {
|
|
862
|
+
// string
|
|
863
|
+
pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
864
|
+
// TransferOwnerRequest
|
|
865
|
+
transferOwnerRequest: ...,
|
|
866
|
+
} satisfies TransferPathPartOwnerRequest;
|
|
867
|
+
|
|
868
|
+
try {
|
|
869
|
+
const data = await api.transferPathPartOwner(body);
|
|
870
|
+
console.log(data);
|
|
871
|
+
} catch (error) {
|
|
872
|
+
console.error(error);
|
|
873
|
+
}
|
|
874
|
+
}
|
|
875
|
+
|
|
876
|
+
// Run the test
|
|
877
|
+
example().catch(console.error);
|
|
878
|
+
```
|
|
879
|
+
|
|
880
|
+
### Parameters
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
| Name | Type | Description | Notes |
|
|
884
|
+
|------------- | ------------- | ------------- | -------------|
|
|
885
|
+
| **pathPartId** | `string` | | [Defaults to `undefined`] |
|
|
886
|
+
| **transferOwnerRequest** | [TransferOwnerRequest](TransferOwnerRequest.md) | | |
|
|
887
|
+
|
|
888
|
+
### Return type
|
|
889
|
+
|
|
890
|
+
[**TransferOwnerResponse**](TransferOwnerResponse.md)
|
|
891
|
+
|
|
892
|
+
### Authorization
|
|
893
|
+
|
|
894
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
895
|
+
|
|
896
|
+
### HTTP request headers
|
|
897
|
+
|
|
898
|
+
- **Content-Type**: `application/json`
|
|
899
|
+
- **Accept**: `application/json`
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
### HTTP response details
|
|
903
|
+
| Status code | Description | Response headers |
|
|
904
|
+
|-------------|-------------|------------------|
|
|
905
|
+
| **200** | Successful Response | - |
|
|
906
|
+
| **422** | Validation Error | - |
|
|
907
|
+
| **0** | Error response. | - |
|
|
804
908
|
|
|
805
909
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
806
910
|
|
package/docs/PublicApi.md
CHANGED
|
@@ -63,6 +63,7 @@ No authorization required
|
|
|
63
63
|
| Status code | Description | Response headers |
|
|
64
64
|
|-------------|-------------|------------------|
|
|
65
65
|
| **200** | Successful Response | - |
|
|
66
|
+
| **0** | Error response. | - |
|
|
66
67
|
|
|
67
68
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
68
69
|
|
package/docs/SectionsApi.md
CHANGED
|
@@ -83,6 +83,7 @@ example().catch(console.error);
|
|
|
83
83
|
|-------------|-------------|------------------|
|
|
84
84
|
| **201** | Successful Response | - |
|
|
85
85
|
| **422** | Validation Error | - |
|
|
86
|
+
| **0** | Error response. | - |
|
|
86
87
|
|
|
87
88
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
88
89
|
|
|
@@ -157,6 +158,7 @@ example().catch(console.error);
|
|
|
157
158
|
|-------------|-------------|------------------|
|
|
158
159
|
| **204** | Successful Response | - |
|
|
159
160
|
| **422** | Validation Error | - |
|
|
161
|
+
| **0** | Error response. | - |
|
|
160
162
|
|
|
161
163
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
162
164
|
|
|
@@ -231,6 +233,7 @@ example().catch(console.error);
|
|
|
231
233
|
|-------------|-------------|------------------|
|
|
232
234
|
| **200** | Successful Response | - |
|
|
233
235
|
| **422** | Validation Error | - |
|
|
236
|
+
| **0** | Error response. | - |
|
|
234
237
|
|
|
235
238
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
236
239
|
|
|
@@ -305,6 +308,7 @@ example().catch(console.error);
|
|
|
305
308
|
|-------------|-------------|------------------|
|
|
306
309
|
| **200** | Successful Response | - |
|
|
307
310
|
| **422** | Validation Error | - |
|
|
311
|
+
| **0** | Error response. | - |
|
|
308
312
|
|
|
309
313
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
310
314
|
|
|
@@ -379,6 +383,7 @@ example().catch(console.error);
|
|
|
379
383
|
|-------------|-------------|------------------|
|
|
380
384
|
| **200** | Successful Response | - |
|
|
381
385
|
| **422** | Validation Error | - |
|
|
386
|
+
| **0** | Error response. | - |
|
|
382
387
|
|
|
383
388
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
384
389
|
|
|
@@ -456,6 +461,7 @@ example().catch(console.error);
|
|
|
456
461
|
|-------------|-------------|------------------|
|
|
457
462
|
| **200** | Successful Response | - |
|
|
458
463
|
| **422** | Validation Error | - |
|
|
464
|
+
| **0** | Error response. | - |
|
|
459
465
|
|
|
460
466
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
461
467
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# SortDirection
|
|
3
|
+
|
|
4
|
+
Client-controlled sort direction for list endpoints.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { SortDirection } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies SortDirection
|
|
19
|
+
|
|
20
|
+
console.log(example)
|
|
21
|
+
|
|
22
|
+
// Convert the instance to a JSON string
|
|
23
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
24
|
+
console.log(exampleJSON)
|
|
25
|
+
|
|
26
|
+
// Parse the JSON string back to an object
|
|
27
|
+
const exampleParsed = JSON.parse(exampleJSON) as SortDirection
|
|
28
|
+
console.log(exampleParsed)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
32
|
+
|
|
33
|
+
|
package/docs/SubscriptionsApi.md
CHANGED
|
@@ -85,6 +85,7 @@ example().catch(console.error);
|
|
|
85
85
|
|-------------|-------------|------------------|
|
|
86
86
|
| **202** | Successful Response | - |
|
|
87
87
|
| **422** | Validation Error | - |
|
|
88
|
+
| **0** | Error response. | - |
|
|
88
89
|
|
|
89
90
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
90
91
|
|
|
@@ -159,6 +160,7 @@ example().catch(console.error);
|
|
|
159
160
|
|-------------|-------------|------------------|
|
|
160
161
|
| **200** | Successful Response | - |
|
|
161
162
|
| **422** | Validation Error | - |
|
|
163
|
+
| **0** | Error response. | - |
|
|
162
164
|
|
|
163
165
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
164
166
|
|
package/docs/TagOrder.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# TagOrder
|
|
3
|
+
|
|
4
|
+
Sortable fields for tag listings.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { TagOrder } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies TagOrder
|
|
19
|
+
|
|
20
|
+
console.log(example)
|
|
21
|
+
|
|
22
|
+
// Convert the instance to a JSON string
|
|
23
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
24
|
+
console.log(exampleJSON)
|
|
25
|
+
|
|
26
|
+
// Parse the JSON string back to an object
|
|
27
|
+
const exampleParsed = JSON.parse(exampleJSON) as TagOrder
|
|
28
|
+
console.log(exampleParsed)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
32
|
+
|
|
33
|
+
|