@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/TagsApi.md
CHANGED
|
@@ -82,6 +82,7 @@ example().catch(console.error);
|
|
|
82
82
|
|-------------|-------------|------------------|
|
|
83
83
|
| **201** | 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
|
| **204** | 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,13 +232,14 @@ 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
|
|
|
236
239
|
|
|
237
240
|
## listTags
|
|
238
241
|
|
|
239
|
-
> PaginatedResponseTagResponse listTags(limit, offset)
|
|
242
|
+
> PaginatedResponseTagResponse listTags(sortBy, sortDir, nameLike, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
|
|
240
243
|
|
|
241
244
|
List Tags Handler
|
|
242
245
|
|
|
@@ -262,10 +265,24 @@ async function example() {
|
|
|
262
265
|
const api = new TagsApi(config);
|
|
263
266
|
|
|
264
267
|
const body = {
|
|
268
|
+
// TagOrder | Field to sort tags by (default: NAME) (optional)
|
|
269
|
+
sortBy: ...,
|
|
270
|
+
// SortDirection | Sort direction; overrides the field\'s natural default (optional)
|
|
271
|
+
sortDir: ...,
|
|
272
|
+
// string | Case-insensitive substring filter on name (optional)
|
|
273
|
+
nameLike: nameLike_example,
|
|
265
274
|
// number | Number of items per page (optional)
|
|
266
275
|
limit: 56,
|
|
267
276
|
// number | Number of items to skip (optional)
|
|
268
277
|
offset: 56,
|
|
278
|
+
// Date | Only items created at or after this timestamp (inclusive) (optional)
|
|
279
|
+
createdAfter: 2013-10-20T19:20:30+01:00,
|
|
280
|
+
// Date | Only items created strictly before this timestamp (optional)
|
|
281
|
+
createdBefore: 2013-10-20T19:20:30+01:00,
|
|
282
|
+
// Date | Only items updated at or after this timestamp (inclusive) (optional)
|
|
283
|
+
updatedAfter: 2013-10-20T19:20:30+01:00,
|
|
284
|
+
// Date | Only items updated strictly before this timestamp (optional)
|
|
285
|
+
updatedBefore: 2013-10-20T19:20:30+01:00,
|
|
269
286
|
} satisfies ListTagsRequest;
|
|
270
287
|
|
|
271
288
|
try {
|
|
@@ -285,8 +302,15 @@ example().catch(console.error);
|
|
|
285
302
|
|
|
286
303
|
| Name | Type | Description | Notes |
|
|
287
304
|
|------------- | ------------- | ------------- | -------------|
|
|
305
|
+
| **sortBy** | `TagOrder` | Field to sort tags by (default: NAME) | [Optional] [Defaults to `undefined`] [Enum: NAME, CREATED_AT] |
|
|
306
|
+
| **sortDir** | `SortDirection` | Sort direction; overrides the field\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
|
|
307
|
+
| **nameLike** | `string` | Case-insensitive substring filter on name | [Optional] [Defaults to `undefined`] |
|
|
288
308
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
289
309
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
310
|
+
| **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
311
|
+
| **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
312
|
+
| **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
313
|
+
| **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
290
314
|
|
|
291
315
|
### Return type
|
|
292
316
|
|
|
@@ -307,6 +331,7 @@ example().catch(console.error);
|
|
|
307
331
|
|-------------|-------------|------------------|
|
|
308
332
|
| **200** | Successful Response | - |
|
|
309
333
|
| **422** | Validation Error | - |
|
|
334
|
+
| **0** | Error response. | - |
|
|
310
335
|
|
|
311
336
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
312
337
|
|
|
@@ -384,6 +409,7 @@ example().catch(console.error);
|
|
|
384
409
|
|-------------|-------------|------------------|
|
|
385
410
|
| **200** | Successful Response | - |
|
|
386
411
|
| **422** | Validation Error | - |
|
|
412
|
+
| **0** | Error response. | - |
|
|
387
413
|
|
|
388
414
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
389
415
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# TenantGroupOrder
|
|
3
|
+
|
|
4
|
+
Sortable fields for tenant group listings.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { TenantGroupOrder } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies TenantGroupOrder
|
|
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 TenantGroupOrder
|
|
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/TenantGroupsApi.md
CHANGED
|
@@ -93,6 +93,7 @@ example().catch(console.error);
|
|
|
93
93
|
|-------------|-------------|------------------|
|
|
94
94
|
| **201** | Successful Response | - |
|
|
95
95
|
| **422** | Validation Error | - |
|
|
96
|
+
| **0** | Error response. | - |
|
|
96
97
|
|
|
97
98
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
98
99
|
|
|
@@ -170,6 +171,7 @@ example().catch(console.error);
|
|
|
170
171
|
|-------------|-------------|------------------|
|
|
171
172
|
| **201** | Successful Response | - |
|
|
172
173
|
| **422** | Validation Error | - |
|
|
174
|
+
| **0** | Error response. | - |
|
|
173
175
|
|
|
174
176
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
175
177
|
|
|
@@ -244,6 +246,7 @@ example().catch(console.error);
|
|
|
244
246
|
|-------------|-------------|------------------|
|
|
245
247
|
| **201** | Successful Response | - |
|
|
246
248
|
| **422** | Validation Error | - |
|
|
249
|
+
| **0** | Error response. | - |
|
|
247
250
|
|
|
248
251
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
249
252
|
|
|
@@ -321,6 +324,7 @@ example().catch(console.error);
|
|
|
321
324
|
|-------------|-------------|------------------|
|
|
322
325
|
| **204** | Successful Response | - |
|
|
323
326
|
| **422** | Validation Error | - |
|
|
327
|
+
| **0** | Error response. | - |
|
|
324
328
|
|
|
325
329
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
326
330
|
|
|
@@ -395,6 +399,7 @@ example().catch(console.error);
|
|
|
395
399
|
|-------------|-------------|------------------|
|
|
396
400
|
| **204** | Successful Response | - |
|
|
397
401
|
| **422** | Validation Error | - |
|
|
402
|
+
| **0** | Error response. | - |
|
|
398
403
|
|
|
399
404
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
400
405
|
|
|
@@ -469,13 +474,14 @@ example().catch(console.error);
|
|
|
469
474
|
|-------------|-------------|------------------|
|
|
470
475
|
| **200** | Successful Response | - |
|
|
471
476
|
| **422** | Validation Error | - |
|
|
477
|
+
| **0** | Error response. | - |
|
|
472
478
|
|
|
473
479
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
474
480
|
|
|
475
481
|
|
|
476
482
|
## listGroupMembers
|
|
477
483
|
|
|
478
|
-
> PaginatedResponseMembershipResponse listGroupMembers(groupId, limit, offset)
|
|
484
|
+
> PaginatedResponseMembershipResponse listGroupMembers(groupId, sortBy, sortDir, usernameLike, limit, offset)
|
|
479
485
|
|
|
480
486
|
List Group Members Handler
|
|
481
487
|
|
|
@@ -503,6 +509,12 @@ async function example() {
|
|
|
503
509
|
const body = {
|
|
504
510
|
// string
|
|
505
511
|
groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
512
|
+
// GroupMemberOrder | Field to sort members by (default: ADDED_AT) (optional)
|
|
513
|
+
sortBy: ...,
|
|
514
|
+
// SortDirection | Sort direction; overrides the field\'s natural default (optional)
|
|
515
|
+
sortDir: ...,
|
|
516
|
+
// string | Case-insensitive substring filter on member name (optional)
|
|
517
|
+
usernameLike: usernameLike_example,
|
|
506
518
|
// number | Number of items per page (optional)
|
|
507
519
|
limit: 56,
|
|
508
520
|
// number | Number of items to skip (optional)
|
|
@@ -527,6 +539,9 @@ example().catch(console.error);
|
|
|
527
539
|
| Name | Type | Description | Notes |
|
|
528
540
|
|------------- | ------------- | ------------- | -------------|
|
|
529
541
|
| **groupId** | `string` | | [Defaults to `undefined`] |
|
|
542
|
+
| **sortBy** | `GroupMemberOrder` | Field to sort members by (default: ADDED_AT) | [Optional] [Defaults to `undefined`] [Enum: ADDED_AT, USERNAME] |
|
|
543
|
+
| **sortDir** | `SortDirection` | Sort direction; overrides the field\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
|
|
544
|
+
| **usernameLike** | `string` | Case-insensitive substring filter on member name | [Optional] [Defaults to `undefined`] |
|
|
530
545
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
531
546
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
532
547
|
|
|
@@ -549,13 +564,14 @@ example().catch(console.error);
|
|
|
549
564
|
|-------------|-------------|------------------|
|
|
550
565
|
| **200** | Successful Response | - |
|
|
551
566
|
| **422** | Validation Error | - |
|
|
567
|
+
| **0** | Error response. | - |
|
|
552
568
|
|
|
553
569
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
554
570
|
|
|
555
571
|
|
|
556
572
|
## listGroupPermissions
|
|
557
573
|
|
|
558
|
-
> PaginatedResponseGroupPermissionResponse listGroupPermissions(groupId, limit, offset)
|
|
574
|
+
> PaginatedResponseGroupPermissionResponse listGroupPermissions(groupId, sortBy, sortDir, capability, limit, offset)
|
|
559
575
|
|
|
560
576
|
List Group Permissions Handler
|
|
561
577
|
|
|
@@ -583,6 +599,12 @@ async function example() {
|
|
|
583
599
|
const body = {
|
|
584
600
|
// string
|
|
585
601
|
groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
602
|
+
// GroupPermissionOrder | Field to sort permissions by (default: CREATED_AT) (optional)
|
|
603
|
+
sortBy: ...,
|
|
604
|
+
// SortDirection | Sort direction; overrides the field\'s natural default (optional)
|
|
605
|
+
sortDir: ...,
|
|
606
|
+
// PermissionCapability | Filter to permissions with this capability (optional)
|
|
607
|
+
capability: ...,
|
|
586
608
|
// number | Number of items per page (optional)
|
|
587
609
|
limit: 56,
|
|
588
610
|
// number | Number of items to skip (optional)
|
|
@@ -607,6 +629,9 @@ example().catch(console.error);
|
|
|
607
629
|
| Name | Type | Description | Notes |
|
|
608
630
|
|------------- | ------------- | ------------- | -------------|
|
|
609
631
|
| **groupId** | `string` | | [Defaults to `undefined`] |
|
|
632
|
+
| **sortBy** | `GroupPermissionOrder` | Field to sort permissions by (default: CREATED_AT) | [Optional] [Defaults to `undefined`] [Enum: CREATED_AT, CAPABILITY] |
|
|
633
|
+
| **sortDir** | `SortDirection` | Sort direction; overrides the field\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
|
|
634
|
+
| **capability** | `PermissionCapability` | Filter to permissions with this capability | [Optional] [Defaults to `undefined`] [Enum: READ_ONLY, READ_WRITE, READ_WRITE_DELETE] |
|
|
610
635
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
611
636
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
612
637
|
|
|
@@ -629,6 +654,7 @@ example().catch(console.error);
|
|
|
629
654
|
|-------------|-------------|------------------|
|
|
630
655
|
| **200** | Successful Response | - |
|
|
631
656
|
| **422** | Validation Error | - |
|
|
657
|
+
| **0** | Error response. | - |
|
|
632
658
|
|
|
633
659
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
634
660
|
|
|
@@ -694,13 +720,14 @@ This endpoint does not need any parameter.
|
|
|
694
720
|
| Status code | Description | Response headers |
|
|
695
721
|
|-------------|-------------|------------------|
|
|
696
722
|
| **200** | Successful Response | - |
|
|
723
|
+
| **0** | Error response. | - |
|
|
697
724
|
|
|
698
725
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
699
726
|
|
|
700
727
|
|
|
701
728
|
## listTenantGroups
|
|
702
729
|
|
|
703
|
-
> PaginatedResponseGroupResponse listTenantGroups(limit, offset)
|
|
730
|
+
> PaginatedResponseGroupResponse listTenantGroups(sortBy, sortDir, nameLike, hasUserIds, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
|
|
704
731
|
|
|
705
732
|
List Tenant Groups Handler
|
|
706
733
|
|
|
@@ -726,10 +753,26 @@ async function example() {
|
|
|
726
753
|
const api = new TenantGroupsApi(config);
|
|
727
754
|
|
|
728
755
|
const body = {
|
|
756
|
+
// TenantGroupOrder | Field to sort groups by (default: NAME) (optional)
|
|
757
|
+
sortBy: ...,
|
|
758
|
+
// SortDirection | Sort direction; overrides the field\'s natural default (optional)
|
|
759
|
+
sortDir: ...,
|
|
760
|
+
// string | Case-insensitive substring filter on name (optional)
|
|
761
|
+
nameLike: nameLike_example,
|
|
762
|
+
// Array<string> | Only groups containing ALL of these user ids (optional)
|
|
763
|
+
hasUserIds: ...,
|
|
729
764
|
// number | Number of items per page (optional)
|
|
730
765
|
limit: 56,
|
|
731
766
|
// number | Number of items to skip (optional)
|
|
732
767
|
offset: 56,
|
|
768
|
+
// Date | Only items created at or after this timestamp (inclusive) (optional)
|
|
769
|
+
createdAfter: 2013-10-20T19:20:30+01:00,
|
|
770
|
+
// Date | Only items created strictly before this timestamp (optional)
|
|
771
|
+
createdBefore: 2013-10-20T19:20:30+01:00,
|
|
772
|
+
// Date | Only items updated at or after this timestamp (inclusive) (optional)
|
|
773
|
+
updatedAfter: 2013-10-20T19:20:30+01:00,
|
|
774
|
+
// Date | Only items updated strictly before this timestamp (optional)
|
|
775
|
+
updatedBefore: 2013-10-20T19:20:30+01:00,
|
|
733
776
|
} satisfies ListTenantGroupsRequest;
|
|
734
777
|
|
|
735
778
|
try {
|
|
@@ -749,8 +792,16 @@ example().catch(console.error);
|
|
|
749
792
|
|
|
750
793
|
| Name | Type | Description | Notes |
|
|
751
794
|
|------------- | ------------- | ------------- | -------------|
|
|
795
|
+
| **sortBy** | `TenantGroupOrder` | Field to sort groups by (default: NAME) | [Optional] [Defaults to `undefined`] [Enum: NAME, CREATED_AT] |
|
|
796
|
+
| **sortDir** | `SortDirection` | Sort direction; overrides the field\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
|
|
797
|
+
| **nameLike** | `string` | Case-insensitive substring filter on name | [Optional] [Defaults to `undefined`] |
|
|
798
|
+
| **hasUserIds** | `Array<string>` | Only groups containing ALL of these user ids | [Optional] |
|
|
752
799
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
753
800
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
801
|
+
| **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
802
|
+
| **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
803
|
+
| **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
804
|
+
| **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
754
805
|
|
|
755
806
|
### Return type
|
|
756
807
|
|
|
@@ -771,6 +822,7 @@ example().catch(console.error);
|
|
|
771
822
|
|-------------|-------------|------------------|
|
|
772
823
|
| **200** | Successful Response | - |
|
|
773
824
|
| **422** | Validation Error | - |
|
|
825
|
+
| **0** | Error response. | - |
|
|
774
826
|
|
|
775
827
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
776
828
|
|
|
@@ -848,6 +900,7 @@ example().catch(console.error);
|
|
|
848
900
|
|-------------|-------------|------------------|
|
|
849
901
|
| **204** | Successful Response | - |
|
|
850
902
|
| **422** | Validation Error | - |
|
|
903
|
+
| **0** | Error response. | - |
|
|
851
904
|
|
|
852
905
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
853
906
|
|
|
@@ -928,6 +981,7 @@ example().catch(console.error);
|
|
|
928
981
|
|-------------|-------------|------------------|
|
|
929
982
|
| **200** | Successful Response | - |
|
|
930
983
|
| **422** | Validation Error | - |
|
|
984
|
+
| **0** | Error response. | - |
|
|
931
985
|
|
|
932
986
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
933
987
|
|
|
@@ -1005,6 +1059,7 @@ example().catch(console.error);
|
|
|
1005
1059
|
|-------------|-------------|------------------|
|
|
1006
1060
|
| **200** | Successful Response | - |
|
|
1007
1061
|
| **422** | Validation Error | - |
|
|
1062
|
+
| **0** | Error response. | - |
|
|
1008
1063
|
|
|
1009
1064
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1010
1065
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# TenantUserOrder
|
|
3
|
+
|
|
4
|
+
Sortable fields for tenant member listings.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { TenantUserOrder } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies TenantUserOrder
|
|
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 TenantUserOrder
|
|
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/TenantsApi.md
CHANGED
|
@@ -92,6 +92,7 @@ example().catch(console.error);
|
|
|
92
92
|
|-------------|-------------|------------------|
|
|
93
93
|
| **200** | Successful Response | - |
|
|
94
94
|
| **422** | Validation Error | - |
|
|
95
|
+
| **0** | Error response. | - |
|
|
95
96
|
|
|
96
97
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
97
98
|
|
|
@@ -169,6 +170,7 @@ example().catch(console.error);
|
|
|
169
170
|
|-------------|-------------|------------------|
|
|
170
171
|
| **200** | Successful Response | - |
|
|
171
172
|
| **422** | Validation Error | - |
|
|
173
|
+
| **0** | Error response. | - |
|
|
172
174
|
|
|
173
175
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
174
176
|
|
|
@@ -243,6 +245,7 @@ example().catch(console.error);
|
|
|
243
245
|
|-------------|-------------|------------------|
|
|
244
246
|
| **204** | Successful Response | - |
|
|
245
247
|
| **422** | Validation Error | - |
|
|
248
|
+
| **0** | Error response. | - |
|
|
246
249
|
|
|
247
250
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
248
251
|
|
|
@@ -320,6 +323,7 @@ example().catch(console.error);
|
|
|
320
323
|
|-------------|-------------|------------------|
|
|
321
324
|
| **200** | Successful Response | - |
|
|
322
325
|
| **422** | Validation Error | - |
|
|
326
|
+
| **0** | Error response. | - |
|
|
323
327
|
|
|
324
328
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
325
329
|
|
|
@@ -397,6 +401,7 @@ example().catch(console.error);
|
|
|
397
401
|
|-------------|-------------|------------------|
|
|
398
402
|
| **204** | Successful Response | - |
|
|
399
403
|
| **422** | Validation Error | - |
|
|
404
|
+
| **0** | Error response. | - |
|
|
400
405
|
|
|
401
406
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
402
407
|
|
|
@@ -471,6 +476,7 @@ example().catch(console.error);
|
|
|
471
476
|
|-------------|-------------|------------------|
|
|
472
477
|
| **200** | Successful Response | - |
|
|
473
478
|
| **422** | Validation Error | - |
|
|
479
|
+
| **0** | Error response. | - |
|
|
474
480
|
|
|
475
481
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
476
482
|
|
|
@@ -545,13 +551,14 @@ example().catch(console.error);
|
|
|
545
551
|
|-------------|-------------|------------------|
|
|
546
552
|
| **200** | Successful Response | - |
|
|
547
553
|
| **422** | Validation Error | - |
|
|
554
|
+
| **0** | Error response. | - |
|
|
548
555
|
|
|
549
556
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
550
557
|
|
|
551
558
|
|
|
552
559
|
## listTenantUsers
|
|
553
560
|
|
|
554
|
-
> PaginatedResponseTenantUserResponse listTenantUsers(tenantId, limit, offset)
|
|
561
|
+
> PaginatedResponseTenantUserResponse listTenantUsers(tenantId, sortBy, sortDir, role, usernameLike, activeOnly, limit, offset)
|
|
555
562
|
|
|
556
563
|
List Tenant Users
|
|
557
564
|
|
|
@@ -579,6 +586,16 @@ async function example() {
|
|
|
579
586
|
const body = {
|
|
580
587
|
// string
|
|
581
588
|
tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
589
|
+
// TenantUserOrder | Field to sort members by (default: active-first) (optional)
|
|
590
|
+
sortBy: ...,
|
|
591
|
+
// SortDirection | Sort direction; overrides the field\'s natural default (optional)
|
|
592
|
+
sortDir: ...,
|
|
593
|
+
// TenantUserRole | Filter to members with this role (optional)
|
|
594
|
+
role: ...,
|
|
595
|
+
// string | Case-insensitive substring filter on first/last name (optional)
|
|
596
|
+
usernameLike: usernameLike_example,
|
|
597
|
+
// boolean | Exclude deactivated members (optional)
|
|
598
|
+
activeOnly: true,
|
|
582
599
|
// number | Number of items per page (optional)
|
|
583
600
|
limit: 56,
|
|
584
601
|
// number | Number of items to skip (optional)
|
|
@@ -603,6 +620,11 @@ example().catch(console.error);
|
|
|
603
620
|
| Name | Type | Description | Notes |
|
|
604
621
|
|------------- | ------------- | ------------- | -------------|
|
|
605
622
|
| **tenantId** | `string` | | [Defaults to `undefined`] |
|
|
623
|
+
| **sortBy** | `TenantUserOrder` | Field to sort members by (default: active-first) | [Optional] [Defaults to `undefined`] [Enum: ADDED_AT, USERNAME, ROLE] |
|
|
624
|
+
| **sortDir** | `SortDirection` | Sort direction; overrides the field\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
|
|
625
|
+
| **role** | `TenantUserRole` | Filter to members with this role | [Optional] [Defaults to `undefined`] [Enum: USER, OWNER, ADMIN] |
|
|
626
|
+
| **usernameLike** | `string` | Case-insensitive substring filter on first/last name | [Optional] [Defaults to `undefined`] |
|
|
627
|
+
| **activeOnly** | `boolean` | Exclude deactivated members | [Optional] [Defaults to `false`] |
|
|
606
628
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
607
629
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
608
630
|
|
|
@@ -625,6 +647,7 @@ example().catch(console.error);
|
|
|
625
647
|
|-------------|-------------|------------------|
|
|
626
648
|
| **200** | Successful Response | - |
|
|
627
649
|
| **422** | Validation Error | - |
|
|
650
|
+
| **0** | Error response. | - |
|
|
628
651
|
|
|
629
652
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
630
653
|
|
|
@@ -702,6 +725,7 @@ example().catch(console.error);
|
|
|
702
725
|
|-------------|-------------|------------------|
|
|
703
726
|
| **200** | Successful Response | - |
|
|
704
727
|
| **422** | Validation Error | - |
|
|
728
|
+
| **0** | Error response. | - |
|
|
705
729
|
|
|
706
730
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
707
731
|
|
|
@@ -779,6 +803,7 @@ example().catch(console.error);
|
|
|
779
803
|
|-------------|-------------|------------------|
|
|
780
804
|
| **200** | Successful Response | - |
|
|
781
805
|
| **422** | Validation Error | - |
|
|
806
|
+
| **0** | Error response. | - |
|
|
782
807
|
|
|
783
808
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
784
809
|
|
|
@@ -859,6 +884,7 @@ example().catch(console.error);
|
|
|
859
884
|
|-------------|-------------|------------------|
|
|
860
885
|
| **200** | Successful Response | - |
|
|
861
886
|
| **422** | Validation Error | - |
|
|
887
|
+
| **0** | Error response. | - |
|
|
862
888
|
|
|
863
889
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
864
890
|
|
|
@@ -939,6 +965,7 @@ example().catch(console.error);
|
|
|
939
965
|
|-------------|-------------|------------------|
|
|
940
966
|
| **200** | Successful Response | - |
|
|
941
967
|
| **422** | Validation Error | - |
|
|
968
|
+
| **0** | Error response. | - |
|
|
942
969
|
|
|
943
970
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
944
971
|
|
|
@@ -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
|
|
|
@@ -163,13 +164,14 @@ example().catch(console.error);
|
|
|
163
164
|
|-------------|-------------|------------------|
|
|
164
165
|
| **200** | Successful Response | - |
|
|
165
166
|
| **422** | Validation Error | - |
|
|
167
|
+
| **0** | Error response. | - |
|
|
166
168
|
|
|
167
169
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
168
170
|
|
|
169
171
|
|
|
170
172
|
## listThreadMessages
|
|
171
173
|
|
|
172
|
-
> PaginatedResponseThreadMessageResponse listThreadMessages(threadId, before, withDetails, limit, offset)
|
|
174
|
+
> PaginatedResponseThreadMessageResponse listThreadMessages(threadId, before, role, sortDir, withDetails, limit, offset)
|
|
173
175
|
|
|
174
176
|
List Thread Messages Handler
|
|
175
177
|
|
|
@@ -199,6 +201,10 @@ async function example() {
|
|
|
199
201
|
threadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
200
202
|
// Date | Cursor for keyset pagination: only return messages with created_at < this value (optional)
|
|
201
203
|
before: 2013-10-20T19:20:30+01:00,
|
|
204
|
+
// MessageRole | Filter messages by role (USER, ASSISTANT, SYSTEM) (optional)
|
|
205
|
+
role: ...,
|
|
206
|
+
// SortDirection | ASC for oldest-first; default/DESC keeps newest-first (optional)
|
|
207
|
+
sortDir: ...,
|
|
202
208
|
// boolean | Include execution steps in response (default true) (optional)
|
|
203
209
|
withDetails: true,
|
|
204
210
|
// number | Number of items per page (optional)
|
|
@@ -226,6 +232,8 @@ example().catch(console.error);
|
|
|
226
232
|
|------------- | ------------- | ------------- | -------------|
|
|
227
233
|
| **threadId** | `string` | | [Defaults to `undefined`] |
|
|
228
234
|
| **before** | `Date` | Cursor for keyset pagination: only return messages with created_at < this value | [Optional] [Defaults to `undefined`] |
|
|
235
|
+
| **role** | `MessageRole` | Filter messages by role (USER, ASSISTANT, SYSTEM) | [Optional] [Defaults to `undefined`] [Enum: USER, ASSISTANT, SYSTEM] |
|
|
236
|
+
| **sortDir** | `SortDirection` | ASC for oldest-first; default/DESC keeps newest-first | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
|
|
229
237
|
| **withDetails** | `boolean` | Include execution steps in response (default true) | [Optional] [Defaults to `true`] |
|
|
230
238
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
231
239
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
@@ -249,6 +257,7 @@ example().catch(console.error);
|
|
|
249
257
|
|-------------|-------------|------------------|
|
|
250
258
|
| **200** | Successful Response | - |
|
|
251
259
|
| **422** | Validation Error | - |
|
|
260
|
+
| **0** | Error response. | - |
|
|
252
261
|
|
|
253
262
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
254
263
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# ThreadOrder
|
|
3
|
+
|
|
4
|
+
Sortable fields for thread listings.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ThreadOrder } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies ThreadOrder
|
|
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 ThreadOrder
|
|
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/ThreadResponse.md
CHANGED
|
@@ -12,6 +12,7 @@ Name | Type
|
|
|
12
12
|
`parentThreadId` | string
|
|
13
13
|
`materializedPath` | string
|
|
14
14
|
`tenantId` | string
|
|
15
|
+
`owner` | [UserInfo](UserInfo.md)
|
|
15
16
|
`createdAt` | Date
|
|
16
17
|
`updatedAt` | Date
|
|
17
18
|
|
|
@@ -28,6 +29,7 @@ const example = {
|
|
|
28
29
|
"parentThreadId": null,
|
|
29
30
|
"materializedPath": null,
|
|
30
31
|
"tenantId": null,
|
|
32
|
+
"owner": null,
|
|
31
33
|
"createdAt": null,
|
|
32
34
|
"updatedAt": null,
|
|
33
35
|
} satisfies ThreadResponse
|