@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/AuthApi.md
CHANGED
|
@@ -95,6 +95,7 @@ example().catch(console.error);
|
|
|
95
95
|
|-------------|-------------|------------------|
|
|
96
96
|
| **200** | Successful Response | - |
|
|
97
97
|
| **422** | Validation Error | - |
|
|
98
|
+
| **0** | Error response. | - |
|
|
98
99
|
|
|
99
100
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
100
101
|
|
|
@@ -161,6 +162,7 @@ No authorization required
|
|
|
161
162
|
|-------------|-------------|------------------|
|
|
162
163
|
| **201** | Successful Response | - |
|
|
163
164
|
| **422** | Validation Error | - |
|
|
165
|
+
| **0** | Error response. | - |
|
|
164
166
|
|
|
165
167
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
166
168
|
|
|
@@ -229,6 +231,7 @@ No authorization required
|
|
|
229
231
|
|-------------|-------------|------------------|
|
|
230
232
|
| **201** | Successful Response | - |
|
|
231
233
|
| **422** | Validation Error | - |
|
|
234
|
+
| **0** | Error response. | - |
|
|
232
235
|
|
|
233
236
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
234
237
|
|
|
@@ -303,6 +306,7 @@ No authorization required
|
|
|
303
306
|
|-------------|-------------|------------------|
|
|
304
307
|
| **200** | Successful Response | - |
|
|
305
308
|
| **422** | Validation Error | - |
|
|
309
|
+
| **0** | Error response. | - |
|
|
306
310
|
|
|
307
311
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
308
312
|
|
|
@@ -377,6 +381,7 @@ No authorization required
|
|
|
377
381
|
|-------------|-------------|------------------|
|
|
378
382
|
| **200** | Successful Response | - |
|
|
379
383
|
| **422** | Validation Error | - |
|
|
384
|
+
| **0** | Error response. | - |
|
|
380
385
|
|
|
381
386
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
382
387
|
|
|
@@ -448,6 +453,7 @@ No authorization required
|
|
|
448
453
|
|-------------|-------------|------------------|
|
|
449
454
|
| **200** | Successful Response | - |
|
|
450
455
|
| **422** | Validation Error | - |
|
|
456
|
+
| **0** | Error response. | - |
|
|
451
457
|
|
|
452
458
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
453
459
|
|
|
@@ -531,6 +537,7 @@ No authorization required
|
|
|
531
537
|
|-------------|-------------|------------------|
|
|
532
538
|
| **200** | Successful Response | - |
|
|
533
539
|
| **422** | Validation Error | - |
|
|
540
|
+
| **0** | Error response. | - |
|
|
534
541
|
|
|
535
542
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
536
543
|
|
|
@@ -599,6 +606,7 @@ No authorization required
|
|
|
599
606
|
|-------------|-------------|------------------|
|
|
600
607
|
| **200** | Successful Response | - |
|
|
601
608
|
| **422** | Validation Error | - |
|
|
609
|
+
| **0** | Error response. | - |
|
|
602
610
|
|
|
603
611
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
604
612
|
|
|
@@ -667,6 +675,7 @@ No authorization required
|
|
|
667
675
|
|-------------|-------------|------------------|
|
|
668
676
|
| **200** | Successful Response | - |
|
|
669
677
|
| **422** | Validation Error | - |
|
|
678
|
+
| **0** | Error response. | - |
|
|
670
679
|
|
|
671
680
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
672
681
|
|
|
@@ -735,6 +744,7 @@ No authorization required
|
|
|
735
744
|
|-------------|-------------|------------------|
|
|
736
745
|
| **200** | Successful Response | - |
|
|
737
746
|
| **422** | Validation Error | - |
|
|
747
|
+
| **0** | Error response. | - |
|
|
738
748
|
|
|
739
749
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
740
750
|
|
|
@@ -809,6 +819,7 @@ example().catch(console.error);
|
|
|
809
819
|
|-------------|-------------|------------------|
|
|
810
820
|
| **200** | Successful Response | - |
|
|
811
821
|
| **422** | Validation Error | - |
|
|
822
|
+
| **0** | Error response. | - |
|
|
812
823
|
|
|
813
824
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
814
825
|
|
|
@@ -883,6 +894,7 @@ example().catch(console.error);
|
|
|
883
894
|
|-------------|-------------|------------------|
|
|
884
895
|
| **200** | Successful Response | - |
|
|
885
896
|
| **422** | Validation Error | - |
|
|
897
|
+
| **0** | Error response. | - |
|
|
886
898
|
|
|
887
899
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
888
900
|
|
|
@@ -957,6 +969,7 @@ example().catch(console.error);
|
|
|
957
969
|
|-------------|-------------|------------------|
|
|
958
970
|
| **200** | Successful Response | - |
|
|
959
971
|
| **422** | Validation Error | - |
|
|
972
|
+
| **0** | Error response. | - |
|
|
960
973
|
|
|
961
974
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
962
975
|
|
|
@@ -1025,6 +1038,7 @@ No authorization required
|
|
|
1025
1038
|
|-------------|-------------|------------------|
|
|
1026
1039
|
| **200** | Successful Response | - |
|
|
1027
1040
|
| **422** | Validation Error | - |
|
|
1041
|
+
| **0** | Error response. | - |
|
|
1028
1042
|
|
|
1029
1043
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1030
1044
|
|
|
@@ -1093,6 +1107,7 @@ No authorization required
|
|
|
1093
1107
|
|-------------|-------------|------------------|
|
|
1094
1108
|
| **200** | Successful Response | - |
|
|
1095
1109
|
| **422** | Validation Error | - |
|
|
1110
|
+
| **0** | Error response. | - |
|
|
1096
1111
|
|
|
1097
1112
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1098
1113
|
|
|
@@ -1150,13 +1165,14 @@ No authorization required
|
|
|
1150
1165
|
| Status code | Description | Response headers |
|
|
1151
1166
|
|-------------|-------------|------------------|
|
|
1152
1167
|
| **200** | Successful Response | - |
|
|
1168
|
+
| **0** | Error response. | - |
|
|
1153
1169
|
|
|
1154
1170
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1155
1171
|
|
|
1156
1172
|
|
|
1157
1173
|
## ssoSignin
|
|
1158
1174
|
|
|
1159
|
-
> ssoSignin(tenantId, redirect)
|
|
1175
|
+
> ErrorResponse ssoSignin(tenantId, redirect)
|
|
1160
1176
|
|
|
1161
1177
|
Sso Login Handler
|
|
1162
1178
|
|
|
@@ -1204,7 +1220,7 @@ example().catch(console.error);
|
|
|
1204
1220
|
|
|
1205
1221
|
### Return type
|
|
1206
1222
|
|
|
1207
|
-
|
|
1223
|
+
[**ErrorResponse**](ErrorResponse.md)
|
|
1208
1224
|
|
|
1209
1225
|
### Authorization
|
|
1210
1226
|
|
|
@@ -1221,6 +1237,7 @@ No authorization required
|
|
|
1221
1237
|
|-------------|-------------|------------------|
|
|
1222
1238
|
| **307** | Successful Response | - |
|
|
1223
1239
|
| **422** | Validation Error | - |
|
|
1240
|
+
| **0** | Error response. | - |
|
|
1224
1241
|
|
|
1225
1242
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1226
1243
|
|
|
@@ -1289,6 +1306,7 @@ No authorization required
|
|
|
1289
1306
|
|-------------|-------------|------------------|
|
|
1290
1307
|
| **200** | Successful Response | - |
|
|
1291
1308
|
| **422** | Validation Error | - |
|
|
1309
|
+
| **0** | Error response. | - |
|
|
1292
1310
|
|
|
1293
1311
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1294
1312
|
|
package/docs/ChunkLineagesApi.md
CHANGED
|
@@ -80,6 +80,7 @@ example().catch(console.error);
|
|
|
80
80
|
|-------------|-------------|------------------|
|
|
81
81
|
| **201** | 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
|
|
|
@@ -157,6 +158,7 @@ example().catch(console.error);
|
|
|
157
158
|
|-------------|-------------|------------------|
|
|
158
159
|
| **204** | Successful Response | - |
|
|
159
160
|
| **422** | Validation Error | - |
|
|
161
|
+
| **0** | Error response. | - |
|
|
160
162
|
|
|
161
163
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
162
164
|
|
|
@@ -234,6 +236,7 @@ example().catch(console.error);
|
|
|
234
236
|
|-------------|-------------|------------------|
|
|
235
237
|
| **200** | Successful Response | - |
|
|
236
238
|
| **422** | Validation Error | - |
|
|
239
|
+
| **0** | Error response. | - |
|
|
237
240
|
|
|
238
241
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
239
242
|
|
package/docs/ChunksApi.md
CHANGED
|
@@ -86,6 +86,7 @@ example().catch(console.error);
|
|
|
86
86
|
|-------------|-------------|------------------|
|
|
87
87
|
| **201** | Successful Response | - |
|
|
88
88
|
| **422** | Validation Error | - |
|
|
89
|
+
| **0** | Error response. | - |
|
|
89
90
|
|
|
90
91
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
91
92
|
|
|
@@ -160,6 +161,7 @@ example().catch(console.error);
|
|
|
160
161
|
|-------------|-------------|------------------|
|
|
161
162
|
| **204** | Successful Response | - |
|
|
162
163
|
| **422** | Validation Error | - |
|
|
164
|
+
| **0** | Error response. | - |
|
|
163
165
|
|
|
164
166
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
165
167
|
|
|
@@ -237,6 +239,7 @@ example().catch(console.error);
|
|
|
237
239
|
|-------------|-------------|------------------|
|
|
238
240
|
| **200** | Successful Response | - |
|
|
239
241
|
| **422** | Validation Error | - |
|
|
242
|
+
| **0** | Error response. | - |
|
|
240
243
|
|
|
241
244
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
242
245
|
|
|
@@ -301,7 +304,7 @@ example().catch(console.error);
|
|
|
301
304
|
| **chunkId** | `string` | | [Defaults to `undefined`] |
|
|
302
305
|
| **prev** | `number` | Number of preceding items to include (max 50). | [Optional] [Defaults to `1`] |
|
|
303
306
|
| **next** | `number` | Number of succeeding items to include (max 50). | [Optional] [Defaults to `1`] |
|
|
304
|
-
| **contentType** | `PartType` | Filter by content type: SECTION or CHUNK. Omit to return both. SECTION is rejected when the anchor is a chunk (always). | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, DOCUMENT_VERSION, SECTION, CHUNK, THREAD, THREAD_MESSAGE, WORKFLOW_DEFINITION, WORKFLOW_RUN, DATA_SOURCE, DATA_SOURCE_TABLE] |
|
|
307
|
+
| **contentType** | `PartType` | Filter by content type: SECTION or CHUNK. Omit to return both. SECTION is rejected when the anchor is a chunk (always). | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, DOCUMENT_VERSION, SECTION, CHUNK, THREAD, THREAD_MESSAGE, WORKFLOW_DEFINITION, WORKFLOW_RUN, DATA_SOURCE, DATA_SOURCE_TABLE, API_CONNECTION] |
|
|
305
308
|
| **withinSection** | `boolean` | When true (default), traverse only the anchor\'s sibling chain under the same parent. When false, traverse the entire document version in DFS order, crossing section boundaries. | [Optional] [Defaults to `true`] |
|
|
306
309
|
|
|
307
310
|
### Return type
|
|
@@ -323,6 +326,7 @@ example().catch(console.error);
|
|
|
323
326
|
|-------------|-------------|------------------|
|
|
324
327
|
| **200** | Successful Response | - |
|
|
325
328
|
| **422** | Validation Error | - |
|
|
329
|
+
| **0** | Error response. | - |
|
|
326
330
|
|
|
327
331
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
328
332
|
|
|
@@ -397,6 +401,7 @@ example().catch(console.error);
|
|
|
397
401
|
|-------------|-------------|------------------|
|
|
398
402
|
| **200** | 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,6 +551,7 @@ 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
|
|
|
@@ -622,6 +629,7 @@ example().catch(console.error);
|
|
|
622
629
|
|-------------|-------------|------------------|
|
|
623
630
|
| **200** | Successful Response | - |
|
|
624
631
|
| **422** | Validation Error | - |
|
|
632
|
+
| **0** | Error response. | - |
|
|
625
633
|
|
|
626
634
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
627
635
|
|
|
@@ -699,6 +707,7 @@ example().catch(console.error);
|
|
|
699
707
|
|-------------|-------------|------------------|
|
|
700
708
|
| **200** | Successful Response | - |
|
|
701
709
|
| **422** | Validation Error | - |
|
|
710
|
+
| **0** | Error response. | - |
|
|
702
711
|
|
|
703
712
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
704
713
|
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
|
|
2
|
+
# CreateApiConnectionRequest
|
|
3
|
+
|
|
4
|
+
Create an API connection under a folder the caller can write to.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`name` | string
|
|
11
|
+
`parentPathPartId` | string
|
|
12
|
+
`baseUrl` | string
|
|
13
|
+
`networkClass` | [NetworkClass](NetworkClass.md)
|
|
14
|
+
`verifyTls` | boolean
|
|
15
|
+
`authConfig` | [ApiAuthConfig](ApiAuthConfig.md)
|
|
16
|
+
`apiDocs` | string
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import type { CreateApiConnectionRequest } from '@knowledge-stack/ksapi'
|
|
22
|
+
|
|
23
|
+
// TODO: Update the object below with actual values
|
|
24
|
+
const example = {
|
|
25
|
+
"name": null,
|
|
26
|
+
"parentPathPartId": null,
|
|
27
|
+
"baseUrl": null,
|
|
28
|
+
"networkClass": null,
|
|
29
|
+
"verifyTls": null,
|
|
30
|
+
"authConfig": null,
|
|
31
|
+
"apiDocs": null,
|
|
32
|
+
} satisfies CreateApiConnectionRequest
|
|
33
|
+
|
|
34
|
+
console.log(example)
|
|
35
|
+
|
|
36
|
+
// Convert the instance to a JSON string
|
|
37
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
38
|
+
console.log(exampleJSON)
|
|
39
|
+
|
|
40
|
+
// Parse the JSON string back to an object
|
|
41
|
+
const exampleParsed = JSON.parse(exampleJSON) as CreateApiConnectionRequest
|
|
42
|
+
console.log(exampleParsed)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
46
|
+
|
|
47
|
+
|
|
@@ -8,6 +8,7 @@ Request to create a new API key.
|
|
|
8
8
|
Name | Type
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`name` | string
|
|
11
|
+
`expiresAt` | Date
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -17,6 +18,7 @@ import type { CreateApiKeyRequest } from '@knowledge-stack/ksapi'
|
|
|
17
18
|
// TODO: Update the object below with actual values
|
|
18
19
|
const example = {
|
|
19
20
|
"name": null,
|
|
21
|
+
"expiresAt": null,
|
|
20
22
|
} satisfies CreateApiKeyRequest
|
|
21
23
|
|
|
22
24
|
console.log(example)
|
|
@@ -12,6 +12,7 @@ Name | Type
|
|
|
12
12
|
`key` | string
|
|
13
13
|
`keySuffix` | string
|
|
14
14
|
`createdAt` | Date
|
|
15
|
+
`expiresAt` | Date
|
|
15
16
|
|
|
16
17
|
## Example
|
|
17
18
|
|
|
@@ -25,6 +26,7 @@ const example = {
|
|
|
25
26
|
"key": null,
|
|
26
27
|
"keySuffix": null,
|
|
27
28
|
"createdAt": null,
|
|
29
|
+
"expiresAt": null,
|
|
28
30
|
} satisfies CreateApiKeyResponse
|
|
29
31
|
|
|
30
32
|
console.log(example)
|
|
@@ -13,6 +13,7 @@ Name | Type
|
|
|
13
13
|
`parentPathPartId` | string
|
|
14
14
|
`instructionPathPartId` | string
|
|
15
15
|
`approvalRequired` | boolean
|
|
16
|
+
`isTemplate` | boolean
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -27,6 +28,7 @@ const example = {
|
|
|
27
28
|
"parentPathPartId": null,
|
|
28
29
|
"instructionPathPartId": null,
|
|
29
30
|
"approvalRequired": null,
|
|
31
|
+
"isTemplate": null,
|
|
30
32
|
} satisfies CreateWorkflowDefinitionRequest
|
|
31
33
|
|
|
32
34
|
console.log(example)
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# DataSourceQueryResponse
|
|
3
3
|
|
|
4
|
-
Read-only query result. ``generated_sql`` echoes the executed SQL.
|
|
4
|
+
Read-only query result. ``generated_sql`` echoes the executed SQL. ``sql_validation_warnings`` lists non-blocking semantic-lint findings (e.g. aggregate without a filter, fan-out join); empty when the SQL is clean. The query still runs and returns rows regardless of warnings.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
@@ -12,6 +12,7 @@ Name | Type
|
|
|
12
12
|
`rowCount` | number
|
|
13
13
|
`truncated` | boolean
|
|
14
14
|
`generatedSql` | string
|
|
15
|
+
`sqlValidationWarnings` | Array<string>
|
|
15
16
|
|
|
16
17
|
## Example
|
|
17
18
|
|
|
@@ -25,6 +26,7 @@ const example = {
|
|
|
25
26
|
"rowCount": null,
|
|
26
27
|
"truncated": null,
|
|
27
28
|
"generatedSql": null,
|
|
29
|
+
"sqlValidationWarnings": null,
|
|
28
30
|
} satisfies DataSourceQueryResponse
|
|
29
31
|
|
|
30
32
|
console.log(example)
|
|
@@ -16,6 +16,7 @@ Name | Type
|
|
|
16
16
|
`name` | string
|
|
17
17
|
`engine` | [DataSourceEngine](DataSourceEngine.md)
|
|
18
18
|
`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
|
|
19
|
+
`owner` | [UserInfo](UserInfo.md)
|
|
19
20
|
`createdAt` | Date
|
|
20
21
|
`updatedAt` | Date
|
|
21
22
|
|
|
@@ -35,6 +36,7 @@ const example = {
|
|
|
35
36
|
"name": null,
|
|
36
37
|
"engine": null,
|
|
37
38
|
"approvalState": null,
|
|
39
|
+
"owner": null,
|
|
38
40
|
"createdAt": null,
|
|
39
41
|
"updatedAt": null,
|
|
40
42
|
} satisfies DataSourceResponse
|
package/docs/DataSourcesApi.md
CHANGED
|
@@ -84,6 +84,7 @@ example().catch(console.error);
|
|
|
84
84
|
|-------------|-------------|------------------|
|
|
85
85
|
| **201** | Successful Response | - |
|
|
86
86
|
| **422** | Validation Error | - |
|
|
87
|
+
| **0** | Error response. | - |
|
|
87
88
|
|
|
88
89
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
89
90
|
|
|
@@ -158,6 +159,7 @@ example().catch(console.error);
|
|
|
158
159
|
|-------------|-------------|------------------|
|
|
159
160
|
| **200** | Successful Response | - |
|
|
160
161
|
| **422** | Validation Error | - |
|
|
162
|
+
| **0** | Error response. | - |
|
|
161
163
|
|
|
162
164
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
163
165
|
|
|
@@ -232,6 +234,7 @@ example().catch(console.error);
|
|
|
232
234
|
|-------------|-------------|------------------|
|
|
233
235
|
| **200** | Successful Response | - |
|
|
234
236
|
| **422** | Validation Error | - |
|
|
237
|
+
| **0** | Error response. | - |
|
|
235
238
|
|
|
236
239
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
237
240
|
|
|
@@ -309,6 +312,7 @@ example().catch(console.error);
|
|
|
309
312
|
|-------------|-------------|------------------|
|
|
310
313
|
| **201** | Successful Response | - |
|
|
311
314
|
| **422** | Validation Error | - |
|
|
315
|
+
| **0** | Error response. | - |
|
|
312
316
|
|
|
313
317
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
314
318
|
|
|
@@ -386,6 +390,7 @@ example().catch(console.error);
|
|
|
386
390
|
|-------------|-------------|------------------|
|
|
387
391
|
| **200** | Successful Response | - |
|
|
388
392
|
| **422** | Validation Error | - |
|
|
393
|
+
| **0** | Error response. | - |
|
|
389
394
|
|
|
390
395
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
391
396
|
|
|
@@ -460,6 +465,7 @@ example().catch(console.error);
|
|
|
460
465
|
|-------------|-------------|------------------|
|
|
461
466
|
| **204** | Successful Response | - |
|
|
462
467
|
| **422** | Validation Error | - |
|
|
468
|
+
| **0** | Error response. | - |
|
|
463
469
|
|
|
464
470
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
465
471
|
|
|
@@ -540,6 +546,7 @@ example().catch(console.error);
|
|
|
540
546
|
|-------------|-------------|------------------|
|
|
541
547
|
| **200** | Successful Response | - |
|
|
542
548
|
| **422** | Validation Error | - |
|
|
549
|
+
| **0** | Error response. | - |
|
|
543
550
|
|
|
544
551
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
545
552
|
|
package/docs/DefaultApi.md
CHANGED
|
@@ -64,6 +64,7 @@ No authorization required
|
|
|
64
64
|
| Status code | Description | Response headers |
|
|
65
65
|
|-------------|-------------|------------------|
|
|
66
66
|
| **200** | Successful Response | - |
|
|
67
|
+
| **0** | Error response. | - |
|
|
67
68
|
|
|
68
69
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
69
70
|
|
|
@@ -123,6 +124,7 @@ No authorization required
|
|
|
123
124
|
| Status code | Description | Response headers |
|
|
124
125
|
|-------------|-------------|------------------|
|
|
125
126
|
| **200** | Successful Response | - |
|
|
127
|
+
| **0** | Error response. | - |
|
|
126
128
|
|
|
127
129
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
128
130
|
|
|
@@ -83,6 +83,7 @@ example().catch(console.error);
|
|
|
83
83
|
|-------------|-------------|------------------|
|
|
84
84
|
| **200** | Successful Response | - |
|
|
85
85
|
| **422** | Validation Error | - |
|
|
86
|
+
| **0** | Error response. | - |
|
|
86
87
|
|
|
87
88
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
88
89
|
|
|
@@ -157,6 +158,7 @@ example().catch(console.error);
|
|
|
157
158
|
|-------------|-------------|------------------|
|
|
158
159
|
| **200** | Successful Response | - |
|
|
159
160
|
| **422** | Validation Error | - |
|
|
161
|
+
| **0** | Error response. | - |
|
|
160
162
|
|
|
161
163
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
162
164
|
|
|
@@ -231,6 +233,7 @@ example().catch(console.error);
|
|
|
231
233
|
|-------------|-------------|------------------|
|
|
232
234
|
| **204** | Successful Response | - |
|
|
233
235
|
| **422** | Validation Error | - |
|
|
236
|
+
| **0** | Error response. | - |
|
|
234
237
|
|
|
235
238
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
236
239
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# DocumentVersionOrder
|
|
3
|
+
|
|
4
|
+
Sortable fields for document version listings.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { DocumentVersionOrder } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies DocumentVersionOrder
|
|
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 DocumentVersionOrder
|
|
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
|
+
|
|
@@ -87,6 +87,7 @@ example().catch(console.error);
|
|
|
87
87
|
|-------------|-------------|------------------|
|
|
88
88
|
| **200** | Successful Response | - |
|
|
89
89
|
| **422** | Validation Error | - |
|
|
90
|
+
| **0** | Error response. | - |
|
|
90
91
|
|
|
91
92
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
92
93
|
|
|
@@ -161,6 +162,7 @@ example().catch(console.error);
|
|
|
161
162
|
|-------------|-------------|------------------|
|
|
162
163
|
| **201** | Successful Response | - |
|
|
163
164
|
| **422** | Validation Error | - |
|
|
165
|
+
| **0** | Error response. | - |
|
|
164
166
|
|
|
165
167
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
166
168
|
|
|
@@ -235,6 +237,7 @@ example().catch(console.error);
|
|
|
235
237
|
|-------------|-------------|------------------|
|
|
236
238
|
| **204** | Successful Response | - |
|
|
237
239
|
| **422** | Validation Error | - |
|
|
240
|
+
| **0** | Error response. | - |
|
|
238
241
|
|
|
239
242
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
240
243
|
|
|
@@ -312,6 +315,7 @@ example().catch(console.error);
|
|
|
312
315
|
|-------------|-------------|------------------|
|
|
313
316
|
| **200** | Successful Response | - |
|
|
314
317
|
| **422** | Validation Error | - |
|
|
318
|
+
| **0** | Error response. | - |
|
|
315
319
|
|
|
316
320
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
317
321
|
|
|
@@ -389,6 +393,7 @@ example().catch(console.error);
|
|
|
389
393
|
|-------------|-------------|------------------|
|
|
390
394
|
| **200** | Successful Response | - |
|
|
391
395
|
| **422** | Validation Error | - |
|
|
396
|
+
| **0** | Error response. | - |
|
|
392
397
|
|
|
393
398
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
394
399
|
|
|
@@ -464,6 +469,7 @@ example().catch(console.error);
|
|
|
464
469
|
|-------------|-------------|------------------|
|
|
465
470
|
| **200** | Successful Response | - |
|
|
466
471
|
| **422** | Validation Error | - |
|
|
472
|
+
| **0** | Error response. | - |
|
|
467
473
|
|
|
468
474
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
469
475
|
|
|
@@ -550,6 +556,7 @@ example().catch(console.error);
|
|
|
550
556
|
|-------------|-------------|------------------|
|
|
551
557
|
| **200** | Successful Response | - |
|
|
552
558
|
| **422** | Validation Error | - |
|
|
559
|
+
| **0** | Error response. | - |
|
|
553
560
|
|
|
554
561
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
555
562
|
|
|
@@ -627,17 +634,18 @@ example().catch(console.error);
|
|
|
627
634
|
|-------------|-------------|------------------|
|
|
628
635
|
| **200** | Successful Response | - |
|
|
629
636
|
| **422** | Validation Error | - |
|
|
637
|
+
| **0** | Error response. | - |
|
|
630
638
|
|
|
631
639
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
632
640
|
|
|
633
641
|
|
|
634
642
|
## listDocumentVersions
|
|
635
643
|
|
|
636
|
-
> PaginatedResponseDocumentVersionResponse listDocumentVersions(documentId, limit, offset)
|
|
644
|
+
> PaginatedResponseDocumentVersionResponse listDocumentVersions(documentId, sortBy, sortDir, uploaderTenantUserId, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
|
|
637
645
|
|
|
638
646
|
List Document Versions Handler
|
|
639
647
|
|
|
640
|
-
List all versions for a document. Returns versions ordered by version number ascending (v0, v1, v2...).
|
|
648
|
+
List all versions for a document. Returns versions ordered by version number ascending (v0, v1, v2...) by default.
|
|
641
649
|
|
|
642
650
|
### Example
|
|
643
651
|
|
|
@@ -661,10 +669,24 @@ async function example() {
|
|
|
661
669
|
const body = {
|
|
662
670
|
// string | Document ID to list versions for
|
|
663
671
|
documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
672
|
+
// DocumentVersionOrder | Field to sort versions by (default: VERSION) (optional)
|
|
673
|
+
sortBy: ...,
|
|
674
|
+
// SortDirection | Sort direction; overrides the field\'s natural default (optional)
|
|
675
|
+
sortDir: ...,
|
|
676
|
+
// string | Filter to versions created by this user (optional)
|
|
677
|
+
uploaderTenantUserId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
664
678
|
// number | Number of items per page (optional)
|
|
665
679
|
limit: 56,
|
|
666
680
|
// number | Number of items to skip (optional)
|
|
667
681
|
offset: 56,
|
|
682
|
+
// Date | Only items created at or after this timestamp (inclusive) (optional)
|
|
683
|
+
createdAfter: 2013-10-20T19:20:30+01:00,
|
|
684
|
+
// Date | Only items created strictly before this timestamp (optional)
|
|
685
|
+
createdBefore: 2013-10-20T19:20:30+01:00,
|
|
686
|
+
// Date | Only items updated at or after this timestamp (inclusive) (optional)
|
|
687
|
+
updatedAfter: 2013-10-20T19:20:30+01:00,
|
|
688
|
+
// Date | Only items updated strictly before this timestamp (optional)
|
|
689
|
+
updatedBefore: 2013-10-20T19:20:30+01:00,
|
|
668
690
|
} satisfies ListDocumentVersionsRequest;
|
|
669
691
|
|
|
670
692
|
try {
|
|
@@ -685,8 +707,15 @@ example().catch(console.error);
|
|
|
685
707
|
| Name | Type | Description | Notes |
|
|
686
708
|
|------------- | ------------- | ------------- | -------------|
|
|
687
709
|
| **documentId** | `string` | Document ID to list versions for | [Defaults to `undefined`] |
|
|
710
|
+
| **sortBy** | `DocumentVersionOrder` | Field to sort versions by (default: VERSION) | [Optional] [Defaults to `undefined`] [Enum: VERSION, CREATED_AT] |
|
|
711
|
+
| **sortDir** | `SortDirection` | Sort direction; overrides the field\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
|
|
712
|
+
| **uploaderTenantUserId** | `string` | Filter to versions created by this user | [Optional] [Defaults to `undefined`] |
|
|
688
713
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
689
714
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
715
|
+
| **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
716
|
+
| **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
717
|
+
| **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
718
|
+
| **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
690
719
|
|
|
691
720
|
### Return type
|
|
692
721
|
|
|
@@ -707,6 +736,7 @@ example().catch(console.error);
|
|
|
707
736
|
|-------------|-------------|------------------|
|
|
708
737
|
| **200** | Successful Response | - |
|
|
709
738
|
| **422** | Validation Error | - |
|
|
739
|
+
| **0** | Error response. | - |
|
|
710
740
|
|
|
711
741
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
712
742
|
|
|
@@ -784,6 +814,7 @@ example().catch(console.error);
|
|
|
784
814
|
|-------------|-------------|------------------|
|
|
785
815
|
| **200** | Successful Response | - |
|
|
786
816
|
| **422** | Validation Error | - |
|
|
817
|
+
| **0** | Error response. | - |
|
|
787
818
|
|
|
788
819
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
789
820
|
|