@knowledge-stack/ksapi 1.101.2 → 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/DocumentsApi.md
CHANGED
|
@@ -85,6 +85,7 @@ example().catch(console.error);
|
|
|
85
85
|
|-------------|-------------|------------------|
|
|
86
86
|
| **201** | 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
|
| **204** | 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
|
|
|
@@ -236,6 +238,7 @@ example().catch(console.error);
|
|
|
236
238
|
|-------------|-------------|------------------|
|
|
237
239
|
| **200** | Successful Response | - |
|
|
238
240
|
| **422** | Validation Error | - |
|
|
241
|
+
| **0** | Error response. | - |
|
|
239
242
|
|
|
240
243
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
241
244
|
|
|
@@ -311,6 +314,7 @@ example().catch(console.error);
|
|
|
311
314
|
|-------------|-------------|------------------|
|
|
312
315
|
| **200** | Successful Response | - |
|
|
313
316
|
| **422** | Validation Error | - |
|
|
317
|
+
| **0** | Error response. | - |
|
|
314
318
|
|
|
315
319
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
316
320
|
|
|
@@ -409,6 +413,7 @@ example().catch(console.error);
|
|
|
409
413
|
|-------------|-------------|------------------|
|
|
410
414
|
| **201** | Successful Response | - |
|
|
411
415
|
| **422** | Validation Error | - |
|
|
416
|
+
| **0** | Error response. | - |
|
|
412
417
|
|
|
413
418
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
414
419
|
|
|
@@ -504,13 +509,14 @@ example().catch(console.error);
|
|
|
504
509
|
|-------------|-------------|------------------|
|
|
505
510
|
| **201** | Successful Response | - |
|
|
506
511
|
| **422** | Validation Error | - |
|
|
512
|
+
| **0** | Error response. | - |
|
|
507
513
|
|
|
508
514
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
509
515
|
|
|
510
516
|
|
|
511
517
|
## listDocuments
|
|
512
518
|
|
|
513
|
-
> PaginatedResponseDocumentResponse listDocuments(parentPathPartId, sortOrder, withTags, limit, offset)
|
|
519
|
+
> PaginatedResponseDocumentResponse listDocuments(parentPathPartId, sortOrder, sortDir, ownerId, documentType, withTags, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
|
|
514
520
|
|
|
515
521
|
List Documents Handler
|
|
516
522
|
|
|
@@ -540,12 +546,26 @@ async function example() {
|
|
|
540
546
|
parentPathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
541
547
|
// PathOrder | Sort order for results (default: LOGICAL) (optional)
|
|
542
548
|
sortOrder: ...,
|
|
549
|
+
// SortDirection | Sort direction; overrides the column\'s natural default (optional)
|
|
550
|
+
sortDir: ...,
|
|
551
|
+
// string | Filter to documents owned by this user (optional)
|
|
552
|
+
ownerId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
553
|
+
// DocumentType | Filter to documents of this type (optional)
|
|
554
|
+
documentType: ...,
|
|
543
555
|
// boolean | Include tags in the response (default: false) (optional)
|
|
544
556
|
withTags: true,
|
|
545
557
|
// number | Number of items per page (optional)
|
|
546
558
|
limit: 56,
|
|
547
559
|
// number | Number of items to skip (optional)
|
|
548
560
|
offset: 56,
|
|
561
|
+
// Date | Only items created at or after this timestamp (inclusive) (optional)
|
|
562
|
+
createdAfter: 2013-10-20T19:20:30+01:00,
|
|
563
|
+
// Date | Only items created strictly before this timestamp (optional)
|
|
564
|
+
createdBefore: 2013-10-20T19:20:30+01:00,
|
|
565
|
+
// Date | Only items updated at or after this timestamp (inclusive) (optional)
|
|
566
|
+
updatedAfter: 2013-10-20T19:20:30+01:00,
|
|
567
|
+
// Date | Only items updated strictly before this timestamp (optional)
|
|
568
|
+
updatedBefore: 2013-10-20T19:20:30+01:00,
|
|
549
569
|
} satisfies ListDocumentsRequest;
|
|
550
570
|
|
|
551
571
|
try {
|
|
@@ -567,9 +587,16 @@ example().catch(console.error);
|
|
|
567
587
|
|------------- | ------------- | ------------- | -------------|
|
|
568
588
|
| **parentPathPartId** | `string` | Parent PathPart ID (defaults to root) | [Optional] [Defaults to `undefined`] |
|
|
569
589
|
| **sortOrder** | `PathOrder` | Sort order for results (default: LOGICAL) | [Optional] [Defaults to `undefined`] [Enum: LOGICAL, NAME, UPDATED_AT, CREATED_AT] |
|
|
590
|
+
| **sortDir** | `SortDirection` | Sort direction; overrides the column\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
|
|
591
|
+
| **ownerId** | `string` | Filter to documents owned by this user | [Optional] [Defaults to `undefined`] |
|
|
592
|
+
| **documentType** | `DocumentType` | Filter to documents of this type | [Optional] [Defaults to `undefined`] [Enum: PDF, DOCX, PLAINTEXT, IMAGE, XLSX, CSV, PPTX, UNKNOWN] |
|
|
570
593
|
| **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
|
|
571
594
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
572
595
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
596
|
+
| **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
597
|
+
| **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
598
|
+
| **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
599
|
+
| **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
573
600
|
|
|
574
601
|
### Return type
|
|
575
602
|
|
|
@@ -590,6 +617,7 @@ example().catch(console.error);
|
|
|
590
617
|
|-------------|-------------|------------------|
|
|
591
618
|
| **200** | Successful Response | - |
|
|
592
619
|
| **422** | Validation Error | - |
|
|
620
|
+
| **0** | Error response. | - |
|
|
593
621
|
|
|
594
622
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
595
623
|
|
|
@@ -667,6 +695,7 @@ example().catch(console.error);
|
|
|
667
695
|
|-------------|-------------|------------------|
|
|
668
696
|
| **200** | Successful Response | - |
|
|
669
697
|
| **422** | Validation Error | - |
|
|
698
|
+
| **0** | Error response. | - |
|
|
670
699
|
|
|
671
700
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
672
701
|
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# ErrorResponse
|
|
3
|
+
|
|
4
|
+
Standard error body returned for every non-2xx response.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`detail` | string
|
|
11
|
+
`code` | string
|
|
12
|
+
`requestId` | string
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { ErrorResponse } from '@knowledge-stack/ksapi'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"detail": null,
|
|
22
|
+
"code": null,
|
|
23
|
+
"requestId": null,
|
|
24
|
+
} satisfies ErrorResponse
|
|
25
|
+
|
|
26
|
+
console.log(example)
|
|
27
|
+
|
|
28
|
+
// Convert the instance to a JSON string
|
|
29
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
30
|
+
console.log(exampleJSON)
|
|
31
|
+
|
|
32
|
+
// Parse the JSON string back to an object
|
|
33
|
+
const exampleParsed = JSON.parse(exampleJSON) as ErrorResponse
|
|
34
|
+
console.log(exampleParsed)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
38
|
+
|
|
39
|
+
|
package/docs/FeaturesApi.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/FeedbackApi.md
CHANGED
|
@@ -80,13 +80,14 @@ example().catch(console.error);
|
|
|
80
80
|
|-------------|-------------|------------------|
|
|
81
81
|
| **204** | 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
|
|
|
86
87
|
|
|
87
88
|
## listFeedback
|
|
88
89
|
|
|
89
|
-
> PaginatedResponseFeedbackEventResponse listFeedback(targetType, targetId, rating, limit, offset)
|
|
90
|
+
> PaginatedResponseFeedbackEventResponse listFeedback(targetType, targetId, rating, sortBy, sortDir, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
|
|
90
91
|
|
|
91
92
|
List Feedback Handler
|
|
92
93
|
|
|
@@ -118,10 +119,22 @@ async function example() {
|
|
|
118
119
|
targetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
119
120
|
// FeedbackRating (optional)
|
|
120
121
|
rating: ...,
|
|
122
|
+
// FeedbackOrder | Field to sort feedback by (default: CREATED_AT) (optional)
|
|
123
|
+
sortBy: ...,
|
|
124
|
+
// SortDirection | Sort direction; overrides the field\'s natural default (optional)
|
|
125
|
+
sortDir: ...,
|
|
121
126
|
// number | Number of items per page (optional)
|
|
122
127
|
limit: 56,
|
|
123
128
|
// number | Number of items to skip (optional)
|
|
124
129
|
offset: 56,
|
|
130
|
+
// Date | Only items created at or after this timestamp (inclusive) (optional)
|
|
131
|
+
createdAfter: 2013-10-20T19:20:30+01:00,
|
|
132
|
+
// Date | Only items created strictly before this timestamp (optional)
|
|
133
|
+
createdBefore: 2013-10-20T19:20:30+01:00,
|
|
134
|
+
// Date | Only items updated at or after this timestamp (inclusive) (optional)
|
|
135
|
+
updatedAfter: 2013-10-20T19:20:30+01:00,
|
|
136
|
+
// Date | Only items updated strictly before this timestamp (optional)
|
|
137
|
+
updatedBefore: 2013-10-20T19:20:30+01:00,
|
|
125
138
|
} satisfies ListFeedbackRequest;
|
|
126
139
|
|
|
127
140
|
try {
|
|
@@ -144,8 +157,14 @@ example().catch(console.error);
|
|
|
144
157
|
| **targetType** | `FeedbackTargetType` | | [Optional] [Defaults to `undefined`] [Enum: THREAD, MESSAGE, DOCUMENT, DOCUMENT_VERSION, CHUNK] |
|
|
145
158
|
| **targetId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
146
159
|
| **rating** | `FeedbackRating` | | [Optional] [Defaults to `undefined`] [Enum: UP, DOWN] |
|
|
160
|
+
| **sortBy** | `FeedbackOrder` | Field to sort feedback by (default: CREATED_AT) | [Optional] [Defaults to `undefined`] [Enum: CREATED_AT] |
|
|
161
|
+
| **sortDir** | `SortDirection` | Sort direction; overrides the field\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
|
|
147
162
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
148
163
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
164
|
+
| **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
165
|
+
| **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
166
|
+
| **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
167
|
+
| **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
149
168
|
|
|
150
169
|
### Return type
|
|
151
170
|
|
|
@@ -166,6 +185,7 @@ example().catch(console.error);
|
|
|
166
185
|
|-------------|-------------|------------------|
|
|
167
186
|
| **200** | Successful Response | - |
|
|
168
187
|
| **422** | Validation Error | - |
|
|
188
|
+
| **0** | Error response. | - |
|
|
169
189
|
|
|
170
190
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
171
191
|
|
|
@@ -240,6 +260,7 @@ example().catch(console.error);
|
|
|
240
260
|
|-------------|-------------|------------------|
|
|
241
261
|
| **201** | Successful Response | - |
|
|
242
262
|
| **422** | Validation Error | - |
|
|
263
|
+
| **0** | Error response. | - |
|
|
243
264
|
|
|
244
265
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
245
266
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# FeedbackOrder
|
|
3
|
+
|
|
4
|
+
Sortable fields for feedback listings.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { FeedbackOrder } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies FeedbackOrder
|
|
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 FeedbackOrder
|
|
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/FolderResponse.md
CHANGED
|
@@ -17,6 +17,7 @@ Name | Type
|
|
|
17
17
|
`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
|
|
18
18
|
`excludeFromQdrant` | boolean
|
|
19
19
|
`tenantId` | string
|
|
20
|
+
`owner` | [UserInfo](UserInfo.md)
|
|
20
21
|
`createdAt` | Date
|
|
21
22
|
`updatedAt` | Date
|
|
22
23
|
`tags` | [Array<TagResponse>](TagResponse.md)
|
|
@@ -39,6 +40,7 @@ const example = {
|
|
|
39
40
|
"approvalState": null,
|
|
40
41
|
"excludeFromQdrant": null,
|
|
41
42
|
"tenantId": null,
|
|
43
|
+
"owner": null,
|
|
42
44
|
"createdAt": null,
|
|
43
45
|
"updatedAt": null,
|
|
44
46
|
"tags": null,
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -16,6 +16,7 @@ Name | Type
|
|
|
16
16
|
`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
|
|
17
17
|
`excludeFromQdrant` | boolean
|
|
18
18
|
`tenantId` | string
|
|
19
|
+
`owner` | [UserInfo](UserInfo.md)
|
|
19
20
|
`createdAt` | Date
|
|
20
21
|
`updatedAt` | Date
|
|
21
22
|
`tags` | [Array<TagResponse>](TagResponse.md)
|
|
@@ -24,13 +25,15 @@ Name | Type
|
|
|
24
25
|
`documentOrigin` | [DocumentOrigin](DocumentOrigin.md)
|
|
25
26
|
`activeVersionId` | string
|
|
26
27
|
`activeVersion` | [DocumentVersionResponse](DocumentVersionResponse.md)
|
|
27
|
-
`owner` | [UserInfo](UserInfo.md)
|
|
28
28
|
`checkout` | [DocumentCheckoutResponse](DocumentCheckoutResponse.md)
|
|
29
29
|
`description` | string
|
|
30
30
|
`maxRunDurationSeconds` | number
|
|
31
31
|
`instructionPathPartId` | string
|
|
32
32
|
`isActive` | boolean
|
|
33
33
|
`approvalRequired` | boolean
|
|
34
|
+
`isTemplate` | boolean
|
|
35
|
+
`createdFromId` | string
|
|
36
|
+
`copyCount` | number
|
|
34
37
|
`workflowDefinitionId` | string
|
|
35
38
|
`triggeredBy` | [UserInfo](UserInfo.md)
|
|
36
39
|
`executionState` | [WorkflowExecutionState](WorkflowExecutionState.md)
|
|
@@ -48,11 +51,17 @@ Name | Type
|
|
|
48
51
|
`dataSourceId` | string
|
|
49
52
|
`tableName` | string
|
|
50
53
|
`columnConfig` | Array<{ [key: string]: any; }>
|
|
54
|
+
`baseUrl` | string
|
|
55
|
+
`networkClass` | [NetworkClass](NetworkClass.md)
|
|
56
|
+
`verifyTls` | boolean
|
|
57
|
+
`apiDocs` | string
|
|
58
|
+
`disclaimerAcceptedAt` | Date
|
|
59
|
+
`disclaimerAcceptedBy` | string
|
|
51
60
|
|
|
52
61
|
## Example
|
|
53
62
|
|
|
54
63
|
```typescript
|
|
55
|
-
import type {
|
|
64
|
+
import type { FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse } from '@knowledge-stack/ksapi'
|
|
56
65
|
|
|
57
66
|
// TODO: Update the object below with actual values
|
|
58
67
|
const example = {
|
|
@@ -66,6 +75,7 @@ const example = {
|
|
|
66
75
|
"approvalState": null,
|
|
67
76
|
"excludeFromQdrant": null,
|
|
68
77
|
"tenantId": null,
|
|
78
|
+
"owner": null,
|
|
69
79
|
"createdAt": null,
|
|
70
80
|
"updatedAt": null,
|
|
71
81
|
"tags": null,
|
|
@@ -74,13 +84,15 @@ const example = {
|
|
|
74
84
|
"documentOrigin": null,
|
|
75
85
|
"activeVersionId": null,
|
|
76
86
|
"activeVersion": null,
|
|
77
|
-
"owner": null,
|
|
78
87
|
"checkout": null,
|
|
79
88
|
"description": null,
|
|
80
89
|
"maxRunDurationSeconds": null,
|
|
81
90
|
"instructionPathPartId": null,
|
|
82
91
|
"isActive": null,
|
|
83
92
|
"approvalRequired": null,
|
|
93
|
+
"isTemplate": null,
|
|
94
|
+
"createdFromId": null,
|
|
95
|
+
"copyCount": null,
|
|
84
96
|
"workflowDefinitionId": null,
|
|
85
97
|
"triggeredBy": null,
|
|
86
98
|
"executionState": null,
|
|
@@ -98,7 +110,13 @@ const example = {
|
|
|
98
110
|
"dataSourceId": null,
|
|
99
111
|
"tableName": null,
|
|
100
112
|
"columnConfig": null,
|
|
101
|
-
|
|
113
|
+
"baseUrl": null,
|
|
114
|
+
"networkClass": null,
|
|
115
|
+
"verifyTls": null,
|
|
116
|
+
"apiDocs": null,
|
|
117
|
+
"disclaimerAcceptedAt": null,
|
|
118
|
+
"disclaimerAcceptedBy": null,
|
|
119
|
+
} satisfies FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse
|
|
102
120
|
|
|
103
121
|
console.log(example)
|
|
104
122
|
|
|
@@ -107,7 +125,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
107
125
|
console.log(exampleJSON)
|
|
108
126
|
|
|
109
127
|
// Parse the JSON string back to an object
|
|
110
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
128
|
+
const exampleParsed = JSON.parse(exampleJSON) as FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse
|
|
111
129
|
console.log(exampleParsed)
|
|
112
130
|
```
|
|
113
131
|
|
package/docs/FoldersApi.md
CHANGED
|
@@ -85,6 +85,7 @@ example().catch(console.error);
|
|
|
85
85
|
|-------------|-------------|------------------|
|
|
86
86
|
| **201** | 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
|
| **204** | 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
|
|
|
@@ -236,6 +238,7 @@ example().catch(console.error);
|
|
|
236
238
|
|-------------|-------------|------------------|
|
|
237
239
|
| **200** | Successful Response | - |
|
|
238
240
|
| **422** | Validation Error | - |
|
|
241
|
+
| **0** | Error response. | - |
|
|
239
242
|
|
|
240
243
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
241
244
|
|
|
@@ -311,13 +314,14 @@ example().catch(console.error);
|
|
|
311
314
|
|-------------|-------------|------------------|
|
|
312
315
|
| **200** | Successful Response | - |
|
|
313
316
|
| **422** | Validation Error | - |
|
|
317
|
+
| **0** | Error response. | - |
|
|
314
318
|
|
|
315
319
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
316
320
|
|
|
317
321
|
|
|
318
322
|
## listFolderContents
|
|
319
323
|
|
|
320
|
-
>
|
|
324
|
+
> PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, withTags, limit, offset)
|
|
321
325
|
|
|
322
326
|
List Folder Contents Handler
|
|
323
327
|
|
|
@@ -383,7 +387,7 @@ example().catch(console.error);
|
|
|
383
387
|
|
|
384
388
|
### Return type
|
|
385
389
|
|
|
386
|
-
[**
|
|
390
|
+
[**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md)
|
|
387
391
|
|
|
388
392
|
### Authorization
|
|
389
393
|
|
|
@@ -400,13 +404,14 @@ example().catch(console.error);
|
|
|
400
404
|
|-------------|-------------|------------------|
|
|
401
405
|
| **200** | Successful Response | - |
|
|
402
406
|
| **422** | Validation Error | - |
|
|
407
|
+
| **0** | Error response. | - |
|
|
403
408
|
|
|
404
409
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
405
410
|
|
|
406
411
|
|
|
407
412
|
## listFolders
|
|
408
413
|
|
|
409
|
-
> PaginatedResponseFolderResponse listFolders(parentPathPartId, sortOrder, withTags, limit, offset)
|
|
414
|
+
> PaginatedResponseFolderResponse listFolders(parentPathPartId, sortOrder, sortDir, ownerId, withTags, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
|
|
410
415
|
|
|
411
416
|
List Folders Handler
|
|
412
417
|
|
|
@@ -436,12 +441,24 @@ async function example() {
|
|
|
436
441
|
parentPathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
437
442
|
// PathOrder | Sort order for results (default: LOGICAL) (optional)
|
|
438
443
|
sortOrder: ...,
|
|
444
|
+
// SortDirection | Sort direction; overrides the column\'s natural default (optional)
|
|
445
|
+
sortDir: ...,
|
|
446
|
+
// string | Filter to folders owned by this user (optional)
|
|
447
|
+
ownerId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
439
448
|
// boolean | Include tags in the response (default: false) (optional)
|
|
440
449
|
withTags: true,
|
|
441
450
|
// number | Number of items per page (optional)
|
|
442
451
|
limit: 56,
|
|
443
452
|
// number | Number of items to skip (optional)
|
|
444
453
|
offset: 56,
|
|
454
|
+
// Date | Only items created at or after this timestamp (inclusive) (optional)
|
|
455
|
+
createdAfter: 2013-10-20T19:20:30+01:00,
|
|
456
|
+
// Date | Only items created strictly before this timestamp (optional)
|
|
457
|
+
createdBefore: 2013-10-20T19:20:30+01:00,
|
|
458
|
+
// Date | Only items updated at or after this timestamp (inclusive) (optional)
|
|
459
|
+
updatedAfter: 2013-10-20T19:20:30+01:00,
|
|
460
|
+
// Date | Only items updated strictly before this timestamp (optional)
|
|
461
|
+
updatedBefore: 2013-10-20T19:20:30+01:00,
|
|
445
462
|
} satisfies ListFoldersRequest;
|
|
446
463
|
|
|
447
464
|
try {
|
|
@@ -463,9 +480,15 @@ example().catch(console.error);
|
|
|
463
480
|
|------------- | ------------- | ------------- | -------------|
|
|
464
481
|
| **parentPathPartId** | `string` | Parent PathPart ID (defaults to root) | [Optional] [Defaults to `undefined`] |
|
|
465
482
|
| **sortOrder** | `PathOrder` | Sort order for results (default: LOGICAL) | [Optional] [Defaults to `undefined`] [Enum: LOGICAL, NAME, UPDATED_AT, CREATED_AT] |
|
|
483
|
+
| **sortDir** | `SortDirection` | Sort direction; overrides the column\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
|
|
484
|
+
| **ownerId** | `string` | Filter to folders owned by this user | [Optional] [Defaults to `undefined`] |
|
|
466
485
|
| **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
|
|
467
486
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
468
487
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
488
|
+
| **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
489
|
+
| **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
490
|
+
| **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
491
|
+
| **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
469
492
|
|
|
470
493
|
### Return type
|
|
471
494
|
|
|
@@ -486,13 +509,14 @@ example().catch(console.error);
|
|
|
486
509
|
|-------------|-------------|------------------|
|
|
487
510
|
| **200** | Successful Response | - |
|
|
488
511
|
| **422** | Validation Error | - |
|
|
512
|
+
| **0** | Error response. | - |
|
|
489
513
|
|
|
490
514
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
491
515
|
|
|
492
516
|
|
|
493
517
|
## searchItems
|
|
494
518
|
|
|
495
|
-
>
|
|
519
|
+
> PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator searchItems(nameLike, sortOrder, partType, withTags, parentPathPartId, limit, offset)
|
|
496
520
|
|
|
497
521
|
Search Items Handler
|
|
498
522
|
|
|
@@ -561,7 +585,7 @@ example().catch(console.error);
|
|
|
561
585
|
|
|
562
586
|
### Return type
|
|
563
587
|
|
|
564
|
-
[**
|
|
588
|
+
[**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md)
|
|
565
589
|
|
|
566
590
|
### Authorization
|
|
567
591
|
|
|
@@ -578,6 +602,7 @@ example().catch(console.error);
|
|
|
578
602
|
|-------------|-------------|------------------|
|
|
579
603
|
| **200** | Successful Response | - |
|
|
580
604
|
| **422** | Validation Error | - |
|
|
605
|
+
| **0** | Error response. | - |
|
|
581
606
|
|
|
582
607
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
583
608
|
|
|
@@ -655,6 +680,7 @@ example().catch(console.error);
|
|
|
655
680
|
|-------------|-------------|------------------|
|
|
656
681
|
| **200** | Successful Response | - |
|
|
657
682
|
| **422** | Validation Error | - |
|
|
683
|
+
| **0** | Error response. | - |
|
|
658
684
|
|
|
659
685
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
660
686
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# GroupMemberOrder
|
|
3
|
+
|
|
4
|
+
Sortable fields for group member listings.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { GroupMemberOrder } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies GroupMemberOrder
|
|
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 GroupMemberOrder
|
|
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
|
+
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# GroupPermissionOrder
|
|
3
|
+
|
|
4
|
+
Sortable fields for group permission listings.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { GroupPermissionOrder } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies GroupPermissionOrder
|
|
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 GroupPermissionOrder
|
|
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
|
+
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
# InstantiateWorkflowTemplateRequest
|
|
3
|
+
|
|
4
|
+
Create a runnable workflow by copying a source definition. The source may be a template (the curated case) or any other workflow.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`parentPathPartId` | string
|
|
11
|
+
`name` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { InstantiateWorkflowTemplateRequest } from '@knowledge-stack/ksapi'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"parentPathPartId": null,
|
|
21
|
+
"name": null,
|
|
22
|
+
} satisfies InstantiateWorkflowTemplateRequest
|
|
23
|
+
|
|
24
|
+
console.log(example)
|
|
25
|
+
|
|
26
|
+
// Convert the instance to a JSON string
|
|
27
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
28
|
+
console.log(exampleJSON)
|
|
29
|
+
|
|
30
|
+
// Parse the JSON string back to an object
|
|
31
|
+
const exampleParsed = JSON.parse(exampleJSON) as InstantiateWorkflowTemplateRequest
|
|
32
|
+
console.log(exampleParsed)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
36
|
+
|
|
37
|
+
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# InviteOrder
|
|
3
|
+
|
|
4
|
+
Sortable fields for invite listings.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { InviteOrder } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies InviteOrder
|
|
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 InviteOrder
|
|
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
|
+
|