@hydradb/sdk 2.1.4 → 2.1.6
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/README.md +10 -7
- package/dist/Client.d.ts +1 -1
- package/dist/Client.js +1 -1
- package/dist/api/client/requests/SearchQueryRequest.d.ts +44 -4
- package/dist/api/resources/connectors/client/Client.d.ts +80 -1
- package/dist/api/resources/connectors/client/Client.js +322 -1
- package/dist/api/resources/connectors/client/requests/HandlerConfigureReq.d.ts +7 -0
- package/dist/api/resources/connectors/client/requests/HandlerVaultCredentialRevealReq.d.ts +12 -0
- package/dist/api/resources/connectors/client/requests/HandlerVaultCredentialUpdateReq.d.ts +15 -0
- package/dist/api/resources/connectors/client/requests/PauseConnectorsRequest.d.ts +10 -0
- package/dist/api/resources/connectors/client/requests/ResumeConnectorsRequest.d.ts +10 -0
- package/dist/api/resources/connectors/client/requests/index.d.ts +4 -0
- package/dist/api/resources/context/client/Client.d.ts +45 -5
- package/dist/api/resources/context/client/Client.js +200 -8
- package/dist/api/resources/context/client/requests/ChunksContextRequest.d.ts +31 -0
- package/dist/api/resources/context/client/requests/IngestContextRequest.d.ts +8 -4
- package/dist/api/resources/context/client/requests/ListV2ListContentRequest.d.ts +4 -1
- package/dist/api/resources/context/client/requests/ProfileContextRequest.d.ts +30 -0
- package/dist/api/resources/context/client/requests/RelationsContextRequest.d.ts +1 -1
- package/dist/api/resources/context/client/requests/SourcesV2SourceDeleteRequest.d.ts +4 -1
- package/dist/api/resources/context/client/requests/SubgraphContextRequest.d.ts +8 -8
- package/dist/api/resources/context/client/requests/index.d.ts +2 -0
- package/dist/api/resources/context/types/ChunksContextRequestType.d.ts +6 -0
- package/dist/api/resources/context/types/ChunksContextRequestType.js +9 -0
- package/dist/api/resources/context/types/ListV2ListContentRequestType.d.ts +5 -1
- package/dist/api/resources/context/types/ListV2ListContentRequestType.js +5 -1
- package/dist/api/resources/context/types/ProfileContextRequestType.d.ts +5 -0
- package/dist/api/resources/context/types/ProfileContextRequestType.js +8 -0
- package/dist/api/resources/context/types/RelationsContextRequestType.d.ts +1 -0
- package/dist/api/resources/context/types/RelationsContextRequestType.js +1 -0
- package/dist/api/resources/context/types/SourcesV2SourceDeleteRequestType.d.ts +5 -1
- package/dist/api/resources/context/types/SourcesV2SourceDeleteRequestType.js +5 -1
- package/dist/api/resources/context/types/SubgraphContextRequestType.d.ts +1 -0
- package/dist/api/resources/context/types/SubgraphContextRequestType.js +1 -0
- package/dist/api/resources/context/types/index.d.ts +2 -0
- package/dist/api/resources/context/types/index.js +2 -0
- package/dist/api/resources/databases/client/Client.d.ts +71 -0
- package/dist/api/resources/databases/client/Client.js +309 -0
- package/dist/api/resources/databases/client/requests/DeleteCollectionDatabasesRequest.d.ts +13 -0
- package/dist/api/resources/databases/client/requests/DeleteCollectionDatabasesRequest.js +3 -0
- package/dist/api/resources/databases/client/requests/GetInstructionsDatabasesRequest.d.ts +10 -0
- package/dist/api/resources/databases/client/requests/GetInstructionsDatabasesRequest.js +3 -0
- package/dist/api/resources/databases/client/requests/HandlerInstructionsUpdateReq.d.ts +20 -0
- package/dist/api/resources/databases/client/requests/HandlerInstructionsUpdateReq.js +3 -0
- package/dist/api/resources/databases/client/requests/TenantsTenantCreateRequest.d.ts +1 -0
- package/dist/api/resources/databases/client/requests/TenantsTenantRenameRequest.d.ts +21 -0
- package/dist/api/resources/databases/client/requests/TenantsTenantRenameRequest.js +3 -0
- package/dist/api/resources/databases/client/requests/index.d.ts +4 -0
- package/dist/api/resources/feedback/client/Client.d.ts +1 -3
- package/dist/api/resources/feedback/client/Client.js +1 -3
- package/dist/api/resources/feedback/client/index.d.ts +1 -1
- package/dist/api/resources/feedback/client/index.js +15 -0
- package/dist/api/resources/feedback/client/requests/FeedbackSubmitRequest.d.ts +29 -0
- package/dist/api/resources/feedback/client/requests/FeedbackSubmitRequest.js +3 -0
- package/dist/api/resources/feedback/client/requests/index.d.ts +1 -0
- package/dist/api/resources/feedback/client/requests/index.js +2 -0
- package/dist/api/resources/index.d.ts +1 -0
- package/dist/api/resources/index.js +1 -0
- package/dist/api/types/ConnectorsResource.d.ts +58 -0
- package/dist/api/types/GithubComHydradbHydradbApplicationInternalPlatformStoragelayoutLayout.d.ts +11 -0
- package/dist/api/types/GithubComHydradbHydradbApplicationInternalPlatformStoragelayoutLayout.js +14 -0
- package/dist/api/types/GraphRelationEvidence.d.ts +7 -0
- package/dist/api/types/HandlerConnectorApiView.d.ts +15 -0
- package/dist/api/types/HandlerConnectorCreateResponse.d.ts +15 -0
- package/dist/api/types/HandlerConnectorLimitView.d.ts +15 -0
- package/dist/api/types/HandlerConnectorLimitView.js +3 -0
- package/dist/api/types/HandlerConnectorListResponse.d.ts +8 -3
- package/dist/api/types/HandlerConnectorPauseResponse.d.ts +6 -0
- package/dist/api/types/HandlerConnectorPauseResponse.js +3 -0
- package/dist/api/types/HandlerConnectorResourceStatus.d.ts +27 -0
- package/dist/api/types/HandlerConnectorStatusError.d.ts +4 -3
- package/dist/api/types/HandlerConnectorStatusResponse.d.ts +5 -2
- package/dist/api/types/HandlerEnvelopeSearchChunkInspectResult.d.ts +9 -0
- package/dist/api/types/HandlerEnvelopeSearchChunkInspectResult.js +3 -0
- package/dist/api/types/HandlerEnvelopeSearchEntityProfileView.d.ts +9 -0
- package/dist/api/types/HandlerEnvelopeSearchEntityProfileView.js +3 -0
- package/dist/api/types/HandlerEnvelopeSearchV2RetrievalResult.d.ts +2 -1
- package/dist/api/types/HandlerEnvelopeSearchV2RetrievalResultData.d.ts +5 -0
- package/dist/api/types/HandlerEnvelopeSearchV2RetrievalResultData.js +3 -0
- package/dist/api/types/HandlerEnvelopeTenantsSubTenantDeleteResponse.d.ts +9 -0
- package/dist/api/types/HandlerEnvelopeTenantsSubTenantDeleteResponse.js +3 -0
- package/dist/api/types/HandlerEnvelopeTenantsTenantRenameResponse.d.ts +9 -0
- package/dist/api/types/HandlerEnvelopeTenantsTenantRenameResponse.js +3 -0
- package/dist/api/types/HandlerInstructionsResponse.d.ts +13 -0
- package/dist/api/types/HandlerInstructionsResponse.js +3 -0
- package/dist/api/types/HandlerPlanCapView.d.ts +11 -0
- package/dist/api/types/HandlerPlanCapView.js +3 -0
- package/dist/api/types/HandlerVaultCredentialEntry.d.ts +13 -0
- package/dist/api/types/HandlerVaultCredentialEntry.js +3 -0
- package/dist/api/types/HandlerVaultCredentialListResponse.d.ts +8 -0
- package/dist/api/types/HandlerVaultCredentialListResponse.js +3 -0
- package/dist/api/types/HandlerVaultCredentialRevealResponse.d.ts +7 -0
- package/dist/api/types/HandlerVaultCredentialRevealResponse.js +3 -0
- package/dist/api/types/HandlerVaultCredentialUpdateResponse.d.ts +5 -0
- package/dist/api/types/HandlerVaultCredentialUpdateResponse.js +3 -0
- package/dist/api/types/IngestionGraphEntity.d.ts +8 -0
- package/dist/api/types/IngestionGraphEntity.js +3 -0
- package/dist/api/types/IngestionGraphPayload.d.ts +5 -0
- package/dist/api/types/IngestionGraphPayload.js +3 -0
- package/dist/api/types/IngestionGraphRelation.d.ts +9 -0
- package/dist/api/types/IngestionGraphRelation.js +3 -0
- package/dist/api/types/ListV2MemoryItem.d.ts +8 -0
- package/dist/api/types/ListV2SourceItem.d.ts +8 -0
- package/dist/api/types/MemoriesConversationTurn.d.ts +5 -0
- package/dist/api/types/MemoriesConversationTurn.js +3 -0
- package/dist/api/types/MemoriesForcefulRelations.d.ts +11 -0
- package/dist/api/types/MemoriesForcefulRelations.js +3 -0
- package/dist/api/types/MemoriesIngestItem.d.ts +56 -0
- package/dist/api/types/MemoriesIngestItem.js +3 -0
- package/dist/api/types/MemoriesIngestItemContextCategory.d.ts +13 -0
- package/dist/api/types/MemoriesIngestItemContextCategory.js +16 -0
- package/dist/api/types/MemoriesUnifiedIngestRequest.d.ts +26 -0
- package/dist/api/types/MemoriesUnifiedIngestRequest.js +3 -0
- package/dist/api/types/SearchAliasExpansionNote.d.ts +4 -0
- package/dist/api/types/SearchAliasExpansionNote.js +3 -0
- package/dist/api/types/SearchAppSearchFusionDiagnostics.d.ts +31 -0
- package/dist/api/types/SearchAppSearchFusionDiagnostics.js +3 -0
- package/dist/api/types/SearchAppSearchFusionStats.d.ts +43 -0
- package/dist/api/types/SearchAppSearchFusionStats.js +3 -0
- package/dist/api/types/SearchChunkInspectResult.d.ts +24 -0
- package/dist/api/types/SearchChunkInspectResult.js +3 -0
- package/dist/api/types/SearchCodeSearchRepoResult.d.ts +11 -0
- package/dist/api/types/SearchCodeSearchRepoResult.js +3 -0
- package/dist/api/types/SearchCodeSearchResult.d.ts +24 -0
- package/dist/api/types/SearchCodeSearchResult.js +3 -0
- package/dist/api/types/SearchEntityProfileView.d.ts +18 -0
- package/dist/api/types/SearchEntityProfileView.js +3 -0
- package/dist/api/types/SearchForcefulRelationEntry.d.ts +5 -0
- package/dist/api/types/SearchForcefulRelationEntry.js +3 -0
- package/dist/api/types/SearchForcefulRelationsBucket.d.ts +11 -0
- package/dist/api/types/SearchForcefulRelationsBucket.js +3 -0
- package/dist/api/types/SearchGraphPath.d.ts +10 -0
- package/dist/api/types/SearchGraphPath.js +3 -0
- package/dist/api/types/SearchGraphPlane.d.ts +11 -0
- package/dist/api/types/SearchGraphPlane.js +3 -0
- package/dist/api/types/SearchMetadataFilters.d.ts +1 -1
- package/dist/api/types/SearchProfileContext.d.ts +17 -0
- package/dist/api/types/SearchProfileContext.js +3 -0
- package/dist/api/types/SearchProfileEntry.d.ts +11 -0
- package/dist/api/types/SearchProfileEntry.js +3 -0
- package/dist/api/types/SearchProfileFilterInfo.d.ts +10 -0
- package/dist/api/types/SearchProfileFilterInfo.js +3 -0
- package/dist/api/types/SearchQueryChunk.d.ts +19 -0
- package/dist/api/types/SearchQueryChunk.js +3 -0
- package/dist/api/types/SearchQueryChunkEnrichmentKind.d.ts +7 -0
- package/dist/api/types/SearchQueryChunkEnrichmentKind.js +10 -0
- package/dist/api/types/SearchQueryChunkTemporal.d.ts +8 -0
- package/dist/api/types/SearchQueryChunkTemporal.js +3 -0
- package/dist/api/types/SearchQueryForcefulRelation.d.ts +6 -0
- package/dist/api/types/SearchQueryForcefulRelation.js +3 -0
- package/dist/api/types/SearchQueryGraphEdge.d.ts +13 -0
- package/dist/api/types/SearchQueryGraphEdge.js +3 -0
- package/dist/api/types/SearchQueryGraphEntity.d.ts +4 -0
- package/dist/api/types/SearchQueryGraphEntity.js +3 -0
- package/dist/api/types/SearchQueryGraphPath.d.ts +9 -0
- package/dist/api/types/SearchQueryGraphPath.js +3 -0
- package/dist/api/types/SearchQueryGraphPathOrigin.d.ts +6 -0
- package/dist/api/types/SearchQueryGraphPathOrigin.js +9 -0
- package/dist/api/types/SearchQueryGraphTriplet.d.ts +6 -0
- package/dist/api/types/SearchQueryGraphTriplet.js +3 -0
- package/dist/api/types/SearchQueryResult.d.ts +14 -0
- package/dist/api/types/SearchQueryResult.js +3 -0
- package/dist/api/types/SearchRelationVia.d.ts +4 -0
- package/dist/api/types/SearchRelationVia.js +3 -0
- package/dist/api/types/SearchResolvedReference.d.ts +4 -0
- package/dist/api/types/SearchResolvedReference.js +3 -0
- package/dist/api/types/SearchV2RetrievalResult.d.ts +32 -1
- package/dist/api/types/SearchVectorStoreChunk.d.ts +28 -0
- package/dist/api/types/SearchVectorStoreChunk.js +3 -0
- package/dist/api/types/TenantsDatabaseDetail.d.ts +11 -0
- package/dist/api/types/TenantsDatabaseDetail.js +3 -0
- package/dist/api/types/TenantsDatabaseDetailType.d.ts +9 -0
- package/dist/api/types/TenantsDatabaseDetailType.js +12 -0
- package/dist/api/types/TenantsInfraStatusResponseV2.d.ts +5 -0
- package/dist/api/types/TenantsInfraStatusResponseV2Type.d.ts +8 -0
- package/dist/api/types/TenantsInfraStatusResponseV2Type.js +11 -0
- package/dist/api/types/TenantsMilvusDataType.d.ts +1 -0
- package/dist/api/types/TenantsMilvusDataType.js +1 -0
- package/dist/api/types/TenantsSubTenantDeleteResponse.d.ts +12 -0
- package/dist/api/types/TenantsSubTenantDeleteResponse.js +3 -0
- package/dist/api/types/TenantsTenantIdsResponse.d.ts +2 -0
- package/dist/api/types/TenantsTenantRenameResponse.d.ts +20 -0
- package/dist/api/types/TenantsTenantRenameResponse.js +3 -0
- package/dist/api/types/index.d.ts +54 -6
- package/dist/api/types/index.js +54 -6
- package/dist/helpers/buildString.d.ts +9 -3
- package/dist/helpers/buildString.js +28 -3
- package/dist/serialization/client/requests/SearchQueryRequest.d.ts +7 -0
- package/dist/serialization/client/requests/SearchQueryRequest.js +7 -0
- package/dist/serialization/resources/connectors/client/requests/HandlerConfigureReq.d.ts +1 -0
- package/dist/serialization/resources/connectors/client/requests/HandlerConfigureReq.js +1 -0
- package/dist/serialization/resources/connectors/client/requests/HandlerVaultCredentialRevealReq.d.ts +9 -0
- package/dist/serialization/resources/connectors/client/requests/HandlerVaultCredentialRevealReq.js +41 -0
- package/dist/serialization/resources/connectors/client/requests/HandlerVaultCredentialUpdateReq.d.ts +9 -0
- package/dist/serialization/resources/connectors/client/requests/HandlerVaultCredentialUpdateReq.js +41 -0
- package/dist/serialization/resources/connectors/client/requests/index.d.ts +2 -0
- package/dist/serialization/resources/connectors/client/requests/index.js +5 -1
- package/dist/serialization/resources/context/types/ChunksContextRequestType.d.ts +7 -0
- package/dist/serialization/resources/context/types/ChunksContextRequestType.js +39 -0
- package/dist/serialization/resources/context/types/ListV2ListContentRequestType.d.ts +1 -1
- package/dist/serialization/resources/context/types/ListV2ListContentRequestType.js +1 -1
- package/dist/serialization/resources/context/types/ProfileContextRequestType.d.ts +7 -0
- package/dist/serialization/resources/context/types/ProfileContextRequestType.js +39 -0
- package/dist/serialization/resources/context/types/RelationsContextRequestType.d.ts +1 -1
- package/dist/serialization/resources/context/types/RelationsContextRequestType.js +1 -1
- package/dist/serialization/resources/context/types/SourcesV2SourceDeleteRequestType.d.ts +1 -1
- package/dist/serialization/resources/context/types/SourcesV2SourceDeleteRequestType.js +1 -1
- package/dist/serialization/resources/context/types/SubgraphContextRequestType.d.ts +1 -1
- package/dist/serialization/resources/context/types/SubgraphContextRequestType.js +1 -1
- package/dist/serialization/resources/context/types/index.d.ts +2 -0
- package/dist/serialization/resources/context/types/index.js +2 -0
- package/dist/serialization/resources/databases/client/requests/HandlerInstructionsUpdateReq.d.ts +10 -0
- package/dist/serialization/resources/databases/client/requests/HandlerInstructionsUpdateReq.js +44 -0
- package/dist/serialization/resources/databases/client/requests/TenantsTenantCreateRequest.d.ts +2 -0
- package/dist/serialization/resources/databases/client/requests/TenantsTenantCreateRequest.js +2 -0
- package/dist/serialization/resources/databases/client/requests/TenantsTenantRenameRequest.d.ts +9 -0
- package/dist/serialization/resources/databases/client/requests/TenantsTenantRenameRequest.js +41 -0
- package/dist/serialization/resources/databases/client/requests/index.d.ts +2 -0
- package/dist/serialization/resources/databases/client/requests/index.js +5 -1
- package/dist/serialization/resources/feedback/client/index.d.ts +1 -0
- package/dist/serialization/resources/feedback/client/index.js +17 -0
- package/dist/serialization/resources/feedback/client/requests/FeedbackSubmitRequest.d.ts +21 -0
- package/dist/serialization/{types → resources/feedback/client/requests}/FeedbackSubmitRequest.js +16 -4
- package/dist/serialization/resources/feedback/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/feedback/client/requests/index.js +5 -0
- package/dist/serialization/resources/feedback/index.d.ts +1 -0
- package/dist/serialization/resources/feedback/index.js +17 -0
- package/dist/serialization/resources/index.d.ts +2 -0
- package/dist/serialization/resources/index.js +3 -1
- package/dist/serialization/types/ConnectorsResource.d.ts +6 -0
- package/dist/serialization/types/ConnectorsResource.js +6 -0
- package/dist/serialization/types/GithubComHydradbHydradbApplicationInternalPlatformStoragelayoutLayout.d.ts +7 -0
- package/dist/serialization/types/GithubComHydradbHydradbApplicationInternalPlatformStoragelayoutLayout.js +39 -0
- package/dist/serialization/types/GraphRelationEvidence.d.ts +1 -0
- package/dist/serialization/types/GraphRelationEvidence.js +1 -0
- package/dist/serialization/types/HandlerConnectorApiView.d.ts +3 -0
- package/dist/serialization/types/HandlerConnectorApiView.js +3 -0
- package/dist/serialization/types/HandlerConnectorCreateResponse.d.ts +3 -0
- package/dist/serialization/types/HandlerConnectorCreateResponse.js +3 -0
- package/dist/serialization/types/HandlerConnectorLimitView.d.ts +12 -0
- package/dist/serialization/types/{FeedbackSubmitRequestGroundTruth.js → HandlerConnectorLimitView.js} +6 -4
- package/dist/serialization/types/HandlerConnectorListResponse.d.ts +4 -0
- package/dist/serialization/types/HandlerConnectorListResponse.js +4 -0
- package/dist/serialization/types/HandlerConnectorPauseResponse.d.ts +11 -0
- package/dist/serialization/types/HandlerConnectorPauseResponse.js +43 -0
- package/dist/serialization/types/HandlerConnectorResourceStatus.d.ts +4 -0
- package/dist/serialization/types/HandlerConnectorResourceStatus.js +4 -0
- package/dist/serialization/types/HandlerConnectorStatusResponse.d.ts +2 -0
- package/dist/serialization/types/HandlerConnectorStatusResponse.js +2 -0
- package/dist/serialization/types/HandlerEnvelopeSearchChunkInspectResult.d.ts +15 -0
- package/dist/serialization/types/HandlerEnvelopeSearchChunkInspectResult.js +47 -0
- package/dist/serialization/types/HandlerEnvelopeSearchEntityProfileView.d.ts +15 -0
- package/dist/serialization/types/HandlerEnvelopeSearchEntityProfileView.js +47 -0
- package/dist/serialization/types/HandlerEnvelopeSearchV2RetrievalResult.d.ts +2 -2
- package/dist/serialization/types/HandlerEnvelopeSearchV2RetrievalResult.js +2 -2
- package/dist/serialization/types/HandlerEnvelopeSearchV2RetrievalResultData.d.ts +9 -0
- package/dist/serialization/types/HandlerEnvelopeSearchV2RetrievalResultData.js +41 -0
- package/dist/serialization/types/HandlerEnvelopeTenantsSubTenantDeleteResponse.d.ts +15 -0
- package/dist/serialization/types/HandlerEnvelopeTenantsSubTenantDeleteResponse.js +47 -0
- package/dist/serialization/types/HandlerEnvelopeTenantsTenantRenameResponse.d.ts +15 -0
- package/dist/serialization/types/HandlerEnvelopeTenantsTenantRenameResponse.js +47 -0
- package/dist/serialization/types/HandlerInstructionsResponse.d.ts +12 -0
- package/dist/serialization/types/HandlerInstructionsResponse.js +44 -0
- package/dist/serialization/types/HandlerPlanCapView.d.ts +11 -0
- package/dist/serialization/types/{FeedbackSubmitRequestGroundTruthGroundTruthSourceIds.js → HandlerPlanCapView.js} +5 -3
- package/dist/serialization/types/HandlerVaultCredentialEntry.d.ts +15 -0
- package/dist/serialization/types/HandlerVaultCredentialEntry.js +47 -0
- package/dist/serialization/types/HandlerVaultCredentialListResponse.d.ts +12 -0
- package/dist/serialization/types/HandlerVaultCredentialListResponse.js +44 -0
- package/dist/serialization/types/HandlerVaultCredentialRevealResponse.d.ts +12 -0
- package/dist/serialization/types/HandlerVaultCredentialRevealResponse.js +44 -0
- package/dist/serialization/types/HandlerVaultCredentialUpdateResponse.d.ts +10 -0
- package/dist/serialization/types/HandlerVaultCredentialUpdateResponse.js +42 -0
- package/dist/serialization/types/IngestionGraphEntity.d.ts +12 -0
- package/dist/serialization/types/IngestionGraphEntity.js +44 -0
- package/dist/serialization/types/IngestionGraphPayload.d.ts +12 -0
- package/dist/serialization/types/IngestionGraphPayload.js +44 -0
- package/dist/serialization/types/IngestionGraphRelation.d.ts +13 -0
- package/dist/serialization/types/IngestionGraphRelation.js +45 -0
- package/dist/serialization/types/ListV2MemoryItem.d.ts +1 -0
- package/dist/serialization/types/ListV2MemoryItem.js +1 -0
- package/dist/serialization/types/ListV2SourceItem.d.ts +1 -0
- package/dist/serialization/types/ListV2SourceItem.js +1 -0
- package/dist/serialization/types/MemoriesConversationTurn.d.ts +10 -0
- package/dist/serialization/types/MemoriesConversationTurn.js +42 -0
- package/dist/serialization/types/MemoriesForcefulRelations.d.ts +10 -0
- package/dist/serialization/types/MemoriesForcefulRelations.js +42 -0
- package/dist/serialization/types/MemoriesIngestItem.d.ts +25 -0
- package/dist/serialization/types/MemoriesIngestItem.js +57 -0
- package/dist/serialization/types/MemoriesIngestItemContextCategory.d.ts +7 -0
- package/dist/serialization/types/MemoriesIngestItemContextCategory.js +39 -0
- package/dist/serialization/types/MemoriesUnifiedIngestRequest.d.ts +19 -0
- package/dist/serialization/types/MemoriesUnifiedIngestRequest.js +51 -0
- package/dist/serialization/types/SearchAliasExpansionNote.d.ts +10 -0
- package/dist/serialization/types/SearchAliasExpansionNote.js +42 -0
- package/dist/serialization/types/SearchAppSearchFusionDiagnostics.d.ts +13 -0
- package/dist/serialization/types/SearchAppSearchFusionDiagnostics.js +45 -0
- package/dist/serialization/types/SearchAppSearchFusionStats.d.ts +19 -0
- package/dist/serialization/types/SearchAppSearchFusionStats.js +51 -0
- package/dist/serialization/types/SearchChunkInspectResult.d.ts +14 -0
- package/dist/serialization/types/SearchChunkInspectResult.js +46 -0
- package/dist/serialization/types/SearchCodeSearchRepoResult.d.ts +15 -0
- package/dist/serialization/types/SearchCodeSearchRepoResult.js +47 -0
- package/dist/serialization/types/SearchCodeSearchResult.d.ts +14 -0
- package/dist/serialization/types/SearchCodeSearchResult.js +46 -0
- package/dist/serialization/types/SearchEntityProfileView.d.ts +22 -0
- package/dist/serialization/types/SearchEntityProfileView.js +54 -0
- package/dist/serialization/types/SearchForcefulRelationEntry.d.ts +12 -0
- package/dist/serialization/types/SearchForcefulRelationEntry.js +44 -0
- package/dist/serialization/types/SearchForcefulRelationsBucket.d.ts +11 -0
- package/dist/serialization/types/SearchForcefulRelationsBucket.js +43 -0
- package/dist/serialization/types/SearchGraphPath.d.ts +13 -0
- package/dist/serialization/types/SearchGraphPath.js +45 -0
- package/dist/serialization/types/SearchGraphPlane.d.ts +10 -0
- package/dist/serialization/types/SearchGraphPlane.js +42 -0
- package/dist/serialization/types/SearchProfileContext.d.ts +17 -0
- package/dist/serialization/types/SearchProfileContext.js +49 -0
- package/dist/serialization/types/SearchProfileEntry.d.ts +15 -0
- package/dist/serialization/types/SearchProfileEntry.js +47 -0
- package/dist/serialization/types/SearchProfileFilterInfo.d.ts +15 -0
- package/dist/serialization/types/SearchProfileFilterInfo.js +47 -0
- package/dist/serialization/types/SearchQueryChunk.d.ts +18 -0
- package/dist/serialization/types/SearchQueryChunk.js +50 -0
- package/dist/serialization/types/SearchQueryChunkEnrichmentKind.d.ts +7 -0
- package/dist/serialization/types/SearchQueryChunkEnrichmentKind.js +39 -0
- package/dist/serialization/types/SearchQueryChunkTemporal.d.ts +11 -0
- package/dist/serialization/types/SearchQueryChunkTemporal.js +43 -0
- package/dist/serialization/types/SearchQueryForcefulRelation.d.ts +12 -0
- package/dist/serialization/types/SearchQueryForcefulRelation.js +44 -0
- package/dist/serialization/types/SearchQueryGraphEdge.d.ts +14 -0
- package/dist/serialization/types/SearchQueryGraphEdge.js +46 -0
- package/dist/serialization/types/SearchQueryGraphEntity.d.ts +10 -0
- package/dist/serialization/types/SearchQueryGraphEntity.js +42 -0
- package/dist/serialization/types/SearchQueryGraphPath.d.ts +13 -0
- package/dist/serialization/types/SearchQueryGraphPath.js +45 -0
- package/dist/serialization/types/SearchQueryGraphPathOrigin.d.ts +7 -0
- package/dist/serialization/types/{FeedbackSubmitRequestFeedback.js → SearchQueryGraphPathOrigin.js} +2 -4
- package/dist/serialization/types/SearchQueryGraphTriplet.d.ts +13 -0
- package/dist/serialization/types/SearchQueryGraphTriplet.js +45 -0
- package/dist/serialization/types/SearchQueryResult.d.ts +15 -0
- package/dist/serialization/types/SearchQueryResult.js +47 -0
- package/dist/serialization/types/SearchRelationVia.d.ts +10 -0
- package/dist/serialization/types/{FeedbackSubmitRequestGroundTruthGroundTruthAnswer.js → SearchRelationVia.js} +4 -3
- package/dist/serialization/types/SearchResolvedReference.d.ts +10 -0
- package/dist/serialization/types/SearchResolvedReference.js +42 -0
- package/dist/serialization/types/SearchV2RetrievalResult.d.ts +18 -0
- package/dist/serialization/types/SearchV2RetrievalResult.js +18 -0
- package/dist/serialization/types/SearchVectorStoreChunk.d.ts +21 -0
- package/dist/serialization/types/SearchVectorStoreChunk.js +53 -0
- package/dist/serialization/types/TenantsDatabaseDetail.d.ts +11 -0
- package/dist/serialization/types/TenantsDatabaseDetail.js +43 -0
- package/dist/serialization/types/TenantsDatabaseDetailType.d.ts +7 -0
- package/dist/serialization/types/TenantsDatabaseDetailType.js +39 -0
- package/dist/serialization/types/TenantsInfraStatusResponseV2.d.ts +2 -0
- package/dist/serialization/types/TenantsInfraStatusResponseV2.js +2 -0
- package/dist/serialization/types/TenantsInfraStatusResponseV2Type.d.ts +7 -0
- package/dist/serialization/types/TenantsInfraStatusResponseV2Type.js +39 -0
- package/dist/serialization/types/TenantsSubTenantDeleteResponse.d.ts +14 -0
- package/dist/serialization/types/TenantsSubTenantDeleteResponse.js +46 -0
- package/dist/serialization/types/TenantsTenantIdsResponse.d.ts +2 -0
- package/dist/serialization/types/TenantsTenantIdsResponse.js +2 -0
- package/dist/serialization/types/TenantsTenantRenameResponse.d.ts +15 -0
- package/dist/serialization/types/TenantsTenantRenameResponse.js +47 -0
- package/dist/serialization/types/index.d.ts +54 -6
- package/dist/serialization/types/index.js +54 -6
- package/package.json +1 -1
- package/dist/api/types/FeedbackSubmitRequest.d.ts +0 -2
- package/dist/api/types/FeedbackSubmitRequestFeedback.d.ts +0 -3
- package/dist/api/types/FeedbackSubmitRequestGroundTruth.d.ts +0 -4
- package/dist/api/types/FeedbackSubmitRequestGroundTruthGroundTruth.d.ts +0 -2
- package/dist/api/types/FeedbackSubmitRequestGroundTruthGroundTruthAnswer.d.ts +0 -3
- package/dist/api/types/FeedbackSubmitRequestGroundTruthGroundTruthSourceIds.d.ts +0 -3
- package/dist/serialization/types/FeedbackSubmitRequest.d.ts +0 -9
- package/dist/serialization/types/FeedbackSubmitRequestFeedback.d.ts +0 -9
- package/dist/serialization/types/FeedbackSubmitRequestGroundTruth.d.ts +0 -10
- package/dist/serialization/types/FeedbackSubmitRequestGroundTruthGroundTruth.d.ts +0 -9
- package/dist/serialization/types/FeedbackSubmitRequestGroundTruthGroundTruth.js +0 -44
- package/dist/serialization/types/FeedbackSubmitRequestGroundTruthGroundTruthAnswer.d.ts +0 -9
- package/dist/serialization/types/FeedbackSubmitRequestGroundTruthGroundTruthSourceIds.d.ts +0 -9
- /package/dist/api/{types/FeedbackSubmitRequest.js → resources/connectors/client/requests/HandlerVaultCredentialRevealReq.js} +0 -0
- /package/dist/api/{types/FeedbackSubmitRequestFeedback.js → resources/connectors/client/requests/HandlerVaultCredentialUpdateReq.js} +0 -0
- /package/dist/api/{types/FeedbackSubmitRequestGroundTruth.js → resources/connectors/client/requests/PauseConnectorsRequest.js} +0 -0
- /package/dist/api/{types/FeedbackSubmitRequestGroundTruthGroundTruth.js → resources/connectors/client/requests/ResumeConnectorsRequest.js} +0 -0
- /package/dist/api/{types/FeedbackSubmitRequestGroundTruthGroundTruthAnswer.js → resources/context/client/requests/ChunksContextRequest.js} +0 -0
- /package/dist/api/{types/FeedbackSubmitRequestGroundTruthGroundTruthSourceIds.js → resources/context/client/requests/ProfileContextRequest.js} +0 -0
package/README.md
CHANGED
|
@@ -235,8 +235,8 @@ metadata, checking processing status, reading graph relations, and deleting.
|
|
|
235
235
|
|
|
236
236
|
`POST /context/ingest` (multipart) → `HandlerEnvelopeIngestionV2SourceUploadResponse`
|
|
237
237
|
|
|
238
|
-
Ingest knowledge documents or memories. `documents` is a file
|
|
239
|
-
fields are JSON strings.
|
|
238
|
+
Ingest knowledge documents or memories. `documents` is a list of file uploads (one request may
|
|
239
|
+
carry several); the other structured fields are JSON strings.
|
|
240
240
|
|
|
241
241
|
```typescript
|
|
242
242
|
import { createReadStream } from "fs";
|
|
@@ -244,11 +244,14 @@ import { createReadStream } from "fs";
|
|
|
244
244
|
// Ingest a document file
|
|
245
245
|
const res = await client.context.ingest({
|
|
246
246
|
database: "acme-corp", // required
|
|
247
|
-
documents: createReadStream("handbook.pdf"),
|
|
247
|
+
documents: [createReadStream("handbook.pdf")], // one entry per file
|
|
248
248
|
collection: "hr",
|
|
249
249
|
type: "knowledge",
|
|
250
|
-
// documentMetadata is a JSON *array* — one object per uploaded file.
|
|
251
|
-
|
|
250
|
+
// documentMetadata is a JSON *array* — one object per uploaded file. Your own
|
|
251
|
+
// per-document fields go under `additional_metadata`; the item's other top-level keys
|
|
252
|
+
// are the API's (metadata, evidence_kind, evidence_subject, id, relations, ...) —
|
|
253
|
+
// an unknown top-level key such as `title` is rejected with 400.
|
|
254
|
+
documentMetadata: JSON.stringify([{ additional_metadata: { title: "Employee Handbook", author: "HR" } }]),
|
|
252
255
|
upsert: "true", // form field is a string
|
|
253
256
|
});
|
|
254
257
|
|
|
@@ -265,9 +268,9 @@ await client.context.ingest({
|
|
|
265
268
|
| Field | Type | Notes |
|
|
266
269
|
| ------------------ | ------------------------ | ----- |
|
|
267
270
|
| `database` | `string` (required) | Database (tenant scope). Alias: `tenantId`. |
|
|
268
|
-
| `documents` | `Uploadable`
|
|
271
|
+
| `documents` | `Uploadable[]` | File uploads (stream, `Blob`, `Buffer`, etc.), one entry per file. |
|
|
269
272
|
| `memories` | `string` | JSON **array** string; each item needs `text` (or `user_assistant_pairs`). |
|
|
270
|
-
| `documentMetadata` | `string` | JSON **array** string
|
|
273
|
+
| `documentMetadata` | `string` | JSON **array** string — one object per uploaded file (count must match). Put your own fields under `additional_metadata`; the API's item keys (`metadata`, `evidence_kind`, `evidence_subject`, `id`, `relations`, ...) may sit alongside it. Unknown top-level keys return 400. |
|
|
271
274
|
| `appKnowledge` | `string` | App‑knowledge items as a JSON **array** string (not raw text). |
|
|
272
275
|
| `graphPayload` | `string` | Pre‑computed graph payload. |
|
|
273
276
|
| `collection` | `string` | Collection (sub‑tenant scope). Alias: `subTenantId`. |
|
package/dist/Client.d.ts
CHANGED
|
@@ -51,7 +51,7 @@ export declare class HydraDBClient {
|
|
|
51
51
|
listProviders(request?: HydraDB.ListProvidersRequest, requestOptions?: HydraDBClient.RequestOptions): core.HttpResponsePromise<HydraDB.HandlerProviderListResponse>;
|
|
52
52
|
private __listProviders;
|
|
53
53
|
/**
|
|
54
|
-
* Unified query endpoint that dispatches across type
|
|
54
|
+
* Unified query endpoint that dispatches across type and query_by (hybrid/text). Optionally filter by one or more exact document titles with `titles`; these are resolved to source IDs before normal retrieval. Filter with `attributes` (an operator language, pushed into the vector search); `metadata_filters` is deprecated in favour of it and still works. `type` is knowledge (the default), memory, or all (both, merged). Prefer sub_tenant_ids for sub-tenant scoping; legacy sub_tenant_id is deprecated for /query and cannot be sent together with sub_tenant_ids. The response body always carries `llm_prompt`: the whole result rendered as a single Markdown string (results, related facts, temporal facts, profiles and sources, with citable ids inline), ready to inject verbatim into an LLM context.
|
|
55
55
|
*
|
|
56
56
|
* @param {HydraDB.SearchQueryRequest} request
|
|
57
57
|
* @param {HydraDBClient.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/Client.js
CHANGED
|
@@ -180,7 +180,7 @@ class HydraDBClient {
|
|
|
180
180
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/connectors/providers");
|
|
181
181
|
}
|
|
182
182
|
/**
|
|
183
|
-
* Unified query endpoint that dispatches across type
|
|
183
|
+
* Unified query endpoint that dispatches across type and query_by (hybrid/text). Optionally filter by one or more exact document titles with `titles`; these are resolved to source IDs before normal retrieval. Filter with `attributes` (an operator language, pushed into the vector search); `metadata_filters` is deprecated in favour of it and still works. `type` is knowledge (the default), memory, or all (both, merged). Prefer sub_tenant_ids for sub-tenant scoping; legacy sub_tenant_id is deprecated for /query and cannot be sent together with sub_tenant_ids. The response body always carries `llm_prompt`: the whole result rendered as a single Markdown string (results, related facts, temporal facts, profiles and sources, with citable ids inline), ready to inject verbatim into an LLM context.
|
|
184
184
|
*
|
|
185
185
|
* @param {HydraDB.SearchQueryRequest} request
|
|
186
186
|
* @param {HydraDBClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -20,6 +20,29 @@ export interface SearchQueryRequest {
|
|
|
20
20
|
additionalContext?: string;
|
|
21
21
|
/** Weighting balance between dense and sparse retrieval in hybrid mode. `"auto"` lets HydraDB choose; a number from 0 (full BM25) to 1 (full dense) sets it explicitly. */
|
|
22
22
|
alpha?: unknown;
|
|
23
|
+
/**
|
|
24
|
+
* Attributes is the go-forward metadata filter: a MongoDB-like operator query
|
|
25
|
+
* ($eq/$ne/$gt/$gte/$lt/$lte/$in/$nin/$and/$or/$not/$exists) over the
|
|
26
|
+
* database attributes, translated to a safe Milvus scalar pre-filter by
|
|
27
|
+
* BuildAttributesFilterExpr (PRO-1618). It composes (AND) with the
|
|
28
|
+
* deprecated metadata_filters while both exist. Field names are allowlisted
|
|
29
|
+
* and values escaped, so it is injection-safe.
|
|
30
|
+
*
|
|
31
|
+
* It is applied everywhere metadata_filters is, and nowhere else: the
|
|
32
|
+
* chunks a query returns, the additional context and forceful-relation
|
|
33
|
+
* chunks (the fail-closed post-filter net in the service), and the graph
|
|
34
|
+
* paths, which the graph lane prunes by resolving every source a path
|
|
35
|
+
* cites and dropping the paths that touch one failing the predicate
|
|
36
|
+
* (disallowedGraphSources). Product decision 2026-09-04: `attributes`
|
|
37
|
+
* behaves like `metadata_filters` on every part of the response.
|
|
38
|
+
*/
|
|
39
|
+
attributes?: Record<string, unknown>;
|
|
40
|
+
/**
|
|
41
|
+
* CodeSearch forces the repository code-search branch on (true) or off
|
|
42
|
+
* (false) for this query, overriding the classifier. Nil = let the
|
|
43
|
+
* classifier decide. Only meaningful where the branch is enabled.
|
|
44
|
+
*/
|
|
45
|
+
codeSearch?: boolean;
|
|
23
46
|
/** Collection scope. Defaults to the default collection when omitted. Formerly `sub_tenant_id`; the `sub_tenant_id` alias is still accepted (deprecated). */
|
|
24
47
|
collection?: string;
|
|
25
48
|
/** Preferred /query scope selector. Send either a list of collection IDs for equal normalized weighting, or an object mapping collection ID to a positive relative ranking weight with at most one decimal place. Do not send together with the deprecated sub_tenant_ids or sub_tenant_id. */
|
|
@@ -31,6 +54,8 @@ export interface SearchQueryRequest {
|
|
|
31
54
|
* handler reads it; Database/Collection are carried only for docs/OpenAPI.
|
|
32
55
|
*/
|
|
33
56
|
database?: string;
|
|
57
|
+
/** Whether to follow the relations the author declared at ingest (forceful_relations) and return the related contexts. Defaults to true when omitted. */
|
|
58
|
+
followForcefulRelations?: boolean;
|
|
34
59
|
/** Whether to include graph context in the response. Defaults to true for /query when omitted. */
|
|
35
60
|
graphContext?: boolean;
|
|
36
61
|
/**
|
|
@@ -70,15 +95,28 @@ export interface SearchQueryRequest {
|
|
|
70
95
|
/** Number of adjacent chunks to pull alongside each matched chunk for additional context. */
|
|
71
96
|
numRelatedChunks?: number;
|
|
72
97
|
operator?: HydraDB.SearchOperator;
|
|
98
|
+
/**
|
|
99
|
+
* ProfileEntityType/ProfileNamespace refine the subject's graph identity;
|
|
100
|
+
* defaults ("PERSON"/"users") cover the common case of a person subject.
|
|
101
|
+
*/
|
|
102
|
+
profileEntityType?: string;
|
|
103
|
+
profileNamespace?: string;
|
|
104
|
+
/**
|
|
105
|
+
* ProfileSubject names the entity whose compiled profile should ride the
|
|
106
|
+
* response as profile_context/profile_filter (PRO-1797). Payload-only:
|
|
107
|
+
* chunk ranking is never altered. Omitted = no profile block. Dark until
|
|
108
|
+
* the repo-level ENTITY_PROFILE_CONTEXT_ENABLED flag is on.
|
|
109
|
+
*/
|
|
110
|
+
profileSubject?: string;
|
|
73
111
|
/** Natural-language search query. */
|
|
74
112
|
query?: string;
|
|
75
|
-
/** Whether to include app-aware knowledge retrieval. Applies to knowledge hybrid queries. */
|
|
113
|
+
/** Whether to include app-aware knowledge retrieval. Applies to knowledge hybrid queries. Defaults to true when omitted; pass false to search files only. */
|
|
76
114
|
queryApps?: boolean;
|
|
77
115
|
/** Retrieval method to use for the query. */
|
|
78
116
|
queryBy?: HydraDB.SearchQueryBy;
|
|
79
|
-
/**
|
|
117
|
+
/** Deprecated alias for follow_forceful_relations. Ignored when follow_forceful_relations is sent. */
|
|
80
118
|
queryForcefulRelations?: boolean;
|
|
81
|
-
/** Recency boost applied to ranking. 0
|
|
119
|
+
/** Recency boost applied to ranking (0.0-1.0). Omit it to get the always-on default baseline of 0.40 (a bounded <=40% swing on normalized relevance — it reorders within a relevance gap of up to 0.40 but never buries a more strongly relevant result); send 0 to disable recency entirely; higher values favour more recent sources more strongly. */
|
|
82
120
|
recencyBias?: number;
|
|
83
121
|
/** Deprecated for /query (since 2.0.1). Use collection for a single scope or collections for multiple. Backwards-compatible and will be removed in a future version. Do not send together with a multi-scope selector. */
|
|
84
122
|
subTenantId?: string;
|
|
@@ -106,6 +144,8 @@ export interface SearchQueryRequest {
|
|
|
106
144
|
temporalReasoning?: boolean;
|
|
107
145
|
/** deprecated: use database */
|
|
108
146
|
tenantId?: string;
|
|
109
|
-
/**
|
|
147
|
+
/** Optional exact document-title filter. Values are matched case-insensitively and ORed, resolved to source IDs, then the normal query pipeline runs within that source scope. When ids is also supplied, the two filters are intersected. */
|
|
148
|
+
titles?: string[];
|
|
149
|
+
/** Deprecated: kept for split databases. Corpus to query: knowledge (the default), memory, or all (both, merged). */
|
|
110
150
|
type?: HydraDB.SearchSourceType;
|
|
111
151
|
}
|
|
@@ -174,6 +174,7 @@ export declare class ConnectorsClient {
|
|
|
174
174
|
* @throws {@link HydraDB.NotFoundError}
|
|
175
175
|
* @throws {@link HydraDB.InternalServerError}
|
|
176
176
|
* @throws {@link HydraDB.BadGatewayError}
|
|
177
|
+
* @throws {@link HydraDB.ServiceUnavailableError}
|
|
177
178
|
*
|
|
178
179
|
* @example
|
|
179
180
|
* await client.connectors.discover({
|
|
@@ -182,6 +183,23 @@ export declare class ConnectorsClient {
|
|
|
182
183
|
*/
|
|
183
184
|
discover(request: HydraDB.DiscoverConnectorsRequest, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<HydraDB.HandlerDiscoverResponseBody>;
|
|
184
185
|
private __discover;
|
|
186
|
+
/**
|
|
187
|
+
* Stop scheduling syncs and backfills for a connector until it is resumed. A sync already running is allowed to finish. Cursors are preserved, so resuming continues from where each resource left off.
|
|
188
|
+
*
|
|
189
|
+
* @param {HydraDB.PauseConnectorsRequest} request
|
|
190
|
+
* @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
191
|
+
*
|
|
192
|
+
* @throws {@link HydraDB.NotFoundError}
|
|
193
|
+
* @throws {@link HydraDB.ConflictError}
|
|
194
|
+
* @throws {@link HydraDB.InternalServerError}
|
|
195
|
+
*
|
|
196
|
+
* @example
|
|
197
|
+
* await client.connectors.pause({
|
|
198
|
+
* id: "HydraDoc1234"
|
|
199
|
+
* })
|
|
200
|
+
*/
|
|
201
|
+
pause(request: HydraDB.PauseConnectorsRequest, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<HydraDB.HandlerConnectorPauseResponse>;
|
|
202
|
+
private __pause;
|
|
185
203
|
/**
|
|
186
204
|
* List the configured resources for a connector.
|
|
187
205
|
*
|
|
@@ -256,7 +274,24 @@ export declare class ConnectorsClient {
|
|
|
256
274
|
updateResourceAcl(request: HydraDB.UpdateResourceAclConnectorsRequest, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
|
|
257
275
|
private __updateResourceAcl;
|
|
258
276
|
/**
|
|
259
|
-
*
|
|
277
|
+
* Return a paused connector to the schedule and make it due immediately. Each resource continues from its committed cursor, so data created during the pause is collected on the next cycle rather than skipped.
|
|
278
|
+
*
|
|
279
|
+
* @param {HydraDB.ResumeConnectorsRequest} request
|
|
280
|
+
* @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
281
|
+
*
|
|
282
|
+
* @throws {@link HydraDB.NotFoundError}
|
|
283
|
+
* @throws {@link HydraDB.ConflictError}
|
|
284
|
+
* @throws {@link HydraDB.InternalServerError}
|
|
285
|
+
*
|
|
286
|
+
* @example
|
|
287
|
+
* await client.connectors.resume({
|
|
288
|
+
* id: "HydraDoc1234"
|
|
289
|
+
* })
|
|
290
|
+
*/
|
|
291
|
+
resume(request: HydraDB.ResumeConnectorsRequest, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<HydraDB.HandlerConnectorPauseResponse>;
|
|
292
|
+
private __resume;
|
|
293
|
+
/**
|
|
294
|
+
* Report whether a connector is working, in one call: a rollup status (healthy, degraded, failed, checking) plus per-resource detail. `degraded` means the connector is scheduled but not fully working: at least one configured resource is failing, or the latest sync cycle failed after the resources reported (in which case `error` carries the failure and `retryable` says whether waiting can fix it). `failed` means only the user can fix it: a rejected credential, a blocked connector, or a terminal cycle failure.
|
|
260
295
|
*
|
|
261
296
|
* @param {HydraDB.StatusConnectorsRequest} request
|
|
262
297
|
* @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -289,4 +324,48 @@ export declare class ConnectorsClient {
|
|
|
289
324
|
*/
|
|
290
325
|
sync(request: HydraDB.SyncConnectorsRequest, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<HydraDB.HandlerConnectorSyncResponse>;
|
|
291
326
|
private __sync;
|
|
327
|
+
/**
|
|
328
|
+
* List metadata and field names for credentials already used by connectors in the current workspace.
|
|
329
|
+
*
|
|
330
|
+
* @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
331
|
+
*
|
|
332
|
+
* @example
|
|
333
|
+
* await client.connectors.listConnectorCredentials()
|
|
334
|
+
*/
|
|
335
|
+
listConnectorCredentials(requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<HydraDB.HandlerVaultCredentialListResponse>;
|
|
336
|
+
private __listConnectorCredentials;
|
|
337
|
+
/**
|
|
338
|
+
* Update fields on the credential currently used by a connector. Owner-only human action.
|
|
339
|
+
*
|
|
340
|
+
* @param {HydraDB.HandlerVaultCredentialUpdateReq} request
|
|
341
|
+
* @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
342
|
+
*
|
|
343
|
+
* @throws {@link HydraDB.NotFoundError}
|
|
344
|
+
*
|
|
345
|
+
* @example
|
|
346
|
+
* await client.connectors.updateConnectorCredentials({
|
|
347
|
+
* id: "HydraDoc1234",
|
|
348
|
+
* credentials: {
|
|
349
|
+
* "api_token": "xoxb-..."
|
|
350
|
+
* }
|
|
351
|
+
* })
|
|
352
|
+
*/
|
|
353
|
+
updateConnectorCredentials(request: HydraDB.HandlerVaultCredentialUpdateReq, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<HydraDB.HandlerVaultCredentialUpdateResponse>;
|
|
354
|
+
private __updateConnectorCredentials;
|
|
355
|
+
/**
|
|
356
|
+
* Reveal one field from the credential currently used by a connector in the workspace. The response must never be cached.
|
|
357
|
+
*
|
|
358
|
+
* @param {HydraDB.HandlerVaultCredentialRevealReq} request
|
|
359
|
+
* @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
360
|
+
*
|
|
361
|
+
* @throws {@link HydraDB.NotFoundError}
|
|
362
|
+
*
|
|
363
|
+
* @example
|
|
364
|
+
* await client.connectors.revealAConnectorCredentialValue({
|
|
365
|
+
* id: "HydraDoc1234",
|
|
366
|
+
* field: "field"
|
|
367
|
+
* })
|
|
368
|
+
*/
|
|
369
|
+
revealAConnectorCredentialValue(request: HydraDB.HandlerVaultCredentialRevealReq, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<HydraDB.HandlerVaultCredentialRevealResponse>;
|
|
370
|
+
private __revealAConnectorCredentialValue;
|
|
292
371
|
}
|
|
@@ -683,6 +683,7 @@ class ConnectorsClient {
|
|
|
683
683
|
* @throws {@link HydraDB.NotFoundError}
|
|
684
684
|
* @throws {@link HydraDB.InternalServerError}
|
|
685
685
|
* @throws {@link HydraDB.BadGatewayError}
|
|
686
|
+
* @throws {@link HydraDB.ServiceUnavailableError}
|
|
686
687
|
*
|
|
687
688
|
* @example
|
|
688
689
|
* await client.connectors.discover({
|
|
@@ -751,6 +752,14 @@ class ConnectorsClient {
|
|
|
751
752
|
skipValidation: true,
|
|
752
753
|
breadcrumbsPrefix: ["response"],
|
|
753
754
|
}), _response.rawResponse);
|
|
755
|
+
case 503:
|
|
756
|
+
throw new HydraDB.ServiceUnavailableError(serializers.HandlerErrorResponse.parseOrThrow(_response.error.body, {
|
|
757
|
+
unrecognizedObjectKeys: "passthrough",
|
|
758
|
+
allowUnrecognizedUnionMembers: true,
|
|
759
|
+
allowUnrecognizedEnumValues: true,
|
|
760
|
+
skipValidation: true,
|
|
761
|
+
breadcrumbsPrefix: ["response"],
|
|
762
|
+
}), _response.rawResponse);
|
|
754
763
|
default:
|
|
755
764
|
throw new errors.HydraDBError({
|
|
756
765
|
statusCode: _response.error.statusCode,
|
|
@@ -761,6 +770,71 @@ class ConnectorsClient {
|
|
|
761
770
|
}
|
|
762
771
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/connectors/{id}/discover");
|
|
763
772
|
}
|
|
773
|
+
/**
|
|
774
|
+
* Stop scheduling syncs and backfills for a connector until it is resumed. A sync already running is allowed to finish. Cursors are preserved, so resuming continues from where each resource left off.
|
|
775
|
+
*
|
|
776
|
+
* @param {HydraDB.PauseConnectorsRequest} request
|
|
777
|
+
* @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
778
|
+
*
|
|
779
|
+
* @throws {@link HydraDB.NotFoundError}
|
|
780
|
+
* @throws {@link HydraDB.ConflictError}
|
|
781
|
+
* @throws {@link HydraDB.InternalServerError}
|
|
782
|
+
*
|
|
783
|
+
* @example
|
|
784
|
+
* await client.connectors.pause({
|
|
785
|
+
* id: "HydraDoc1234"
|
|
786
|
+
* })
|
|
787
|
+
*/
|
|
788
|
+
pause(request, requestOptions) {
|
|
789
|
+
return core.HttpResponsePromise.fromPromise(this.__pause(request, requestOptions));
|
|
790
|
+
}
|
|
791
|
+
async __pause(request, requestOptions) {
|
|
792
|
+
const { id } = request;
|
|
793
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
794
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "API-Version": requestOptions?.apiVersion ?? this._options?.apiVersion ?? "2" }), requestOptions?.headers);
|
|
795
|
+
const _response = await core.fetcher({
|
|
796
|
+
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
797
|
+
(await core.Supplier.get(this._options.environment)) ??
|
|
798
|
+
environments.HydraDBEnvironment.Default, `connectors/${core.url.encodePathParam(id)}/pause`),
|
|
799
|
+
method: "POST",
|
|
800
|
+
headers: _headers,
|
|
801
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
802
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
|
803
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
804
|
+
abortSignal: requestOptions?.abortSignal,
|
|
805
|
+
fetchFn: this._options?.fetch,
|
|
806
|
+
logging: this._options.logging,
|
|
807
|
+
});
|
|
808
|
+
if (_response.ok) {
|
|
809
|
+
return {
|
|
810
|
+
data: serializers.HandlerConnectorPauseResponse.parseOrThrow(_response.body, {
|
|
811
|
+
unrecognizedObjectKeys: "passthrough",
|
|
812
|
+
allowUnrecognizedUnionMembers: true,
|
|
813
|
+
allowUnrecognizedEnumValues: true,
|
|
814
|
+
skipValidation: true,
|
|
815
|
+
breadcrumbsPrefix: ["response"],
|
|
816
|
+
}),
|
|
817
|
+
rawResponse: _response.rawResponse,
|
|
818
|
+
};
|
|
819
|
+
}
|
|
820
|
+
if (_response.error.reason === "status-code") {
|
|
821
|
+
switch (_response.error.statusCode) {
|
|
822
|
+
case 404:
|
|
823
|
+
throw new HydraDB.NotFoundError(_response.error.body, _response.rawResponse);
|
|
824
|
+
case 409:
|
|
825
|
+
throw new HydraDB.ConflictError(_response.error.body, _response.rawResponse);
|
|
826
|
+
case 500:
|
|
827
|
+
throw new HydraDB.InternalServerError(_response.error.body, _response.rawResponse);
|
|
828
|
+
default:
|
|
829
|
+
throw new errors.HydraDBError({
|
|
830
|
+
statusCode: _response.error.statusCode,
|
|
831
|
+
body: _response.error.body,
|
|
832
|
+
rawResponse: _response.rawResponse,
|
|
833
|
+
});
|
|
834
|
+
}
|
|
835
|
+
}
|
|
836
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/connectors/{id}/pause");
|
|
837
|
+
}
|
|
764
838
|
/**
|
|
765
839
|
* List the configured resources for a connector.
|
|
766
840
|
*
|
|
@@ -1055,7 +1129,72 @@ class ConnectorsClient {
|
|
|
1055
1129
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/connectors/{id}/resources/{resource_id}");
|
|
1056
1130
|
}
|
|
1057
1131
|
/**
|
|
1058
|
-
*
|
|
1132
|
+
* Return a paused connector to the schedule and make it due immediately. Each resource continues from its committed cursor, so data created during the pause is collected on the next cycle rather than skipped.
|
|
1133
|
+
*
|
|
1134
|
+
* @param {HydraDB.ResumeConnectorsRequest} request
|
|
1135
|
+
* @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1136
|
+
*
|
|
1137
|
+
* @throws {@link HydraDB.NotFoundError}
|
|
1138
|
+
* @throws {@link HydraDB.ConflictError}
|
|
1139
|
+
* @throws {@link HydraDB.InternalServerError}
|
|
1140
|
+
*
|
|
1141
|
+
* @example
|
|
1142
|
+
* await client.connectors.resume({
|
|
1143
|
+
* id: "HydraDoc1234"
|
|
1144
|
+
* })
|
|
1145
|
+
*/
|
|
1146
|
+
resume(request, requestOptions) {
|
|
1147
|
+
return core.HttpResponsePromise.fromPromise(this.__resume(request, requestOptions));
|
|
1148
|
+
}
|
|
1149
|
+
async __resume(request, requestOptions) {
|
|
1150
|
+
const { id } = request;
|
|
1151
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
1152
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "API-Version": requestOptions?.apiVersion ?? this._options?.apiVersion ?? "2" }), requestOptions?.headers);
|
|
1153
|
+
const _response = await core.fetcher({
|
|
1154
|
+
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
1155
|
+
(await core.Supplier.get(this._options.environment)) ??
|
|
1156
|
+
environments.HydraDBEnvironment.Default, `connectors/${core.url.encodePathParam(id)}/resume`),
|
|
1157
|
+
method: "POST",
|
|
1158
|
+
headers: _headers,
|
|
1159
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
1160
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
|
1161
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
1162
|
+
abortSignal: requestOptions?.abortSignal,
|
|
1163
|
+
fetchFn: this._options?.fetch,
|
|
1164
|
+
logging: this._options.logging,
|
|
1165
|
+
});
|
|
1166
|
+
if (_response.ok) {
|
|
1167
|
+
return {
|
|
1168
|
+
data: serializers.HandlerConnectorPauseResponse.parseOrThrow(_response.body, {
|
|
1169
|
+
unrecognizedObjectKeys: "passthrough",
|
|
1170
|
+
allowUnrecognizedUnionMembers: true,
|
|
1171
|
+
allowUnrecognizedEnumValues: true,
|
|
1172
|
+
skipValidation: true,
|
|
1173
|
+
breadcrumbsPrefix: ["response"],
|
|
1174
|
+
}),
|
|
1175
|
+
rawResponse: _response.rawResponse,
|
|
1176
|
+
};
|
|
1177
|
+
}
|
|
1178
|
+
if (_response.error.reason === "status-code") {
|
|
1179
|
+
switch (_response.error.statusCode) {
|
|
1180
|
+
case 404:
|
|
1181
|
+
throw new HydraDB.NotFoundError(_response.error.body, _response.rawResponse);
|
|
1182
|
+
case 409:
|
|
1183
|
+
throw new HydraDB.ConflictError(_response.error.body, _response.rawResponse);
|
|
1184
|
+
case 500:
|
|
1185
|
+
throw new HydraDB.InternalServerError(_response.error.body, _response.rawResponse);
|
|
1186
|
+
default:
|
|
1187
|
+
throw new errors.HydraDBError({
|
|
1188
|
+
statusCode: _response.error.statusCode,
|
|
1189
|
+
body: _response.error.body,
|
|
1190
|
+
rawResponse: _response.rawResponse,
|
|
1191
|
+
});
|
|
1192
|
+
}
|
|
1193
|
+
}
|
|
1194
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/connectors/{id}/resume");
|
|
1195
|
+
}
|
|
1196
|
+
/**
|
|
1197
|
+
* Report whether a connector is working, in one call: a rollup status (healthy, degraded, failed, checking) plus per-resource detail. `degraded` means the connector is scheduled but not fully working: at least one configured resource is failing, or the latest sync cycle failed after the resources reported (in which case `error` carries the failure and `retryable` says whether waiting can fix it). `failed` means only the user can fix it: a rejected credential, a blocked connector, or a terminal cycle failure.
|
|
1059
1198
|
*
|
|
1060
1199
|
* @param {HydraDB.StatusConnectorsRequest} request
|
|
1061
1200
|
* @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -1190,5 +1329,187 @@ class ConnectorsClient {
|
|
|
1190
1329
|
}
|
|
1191
1330
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/connectors/{id}/sync");
|
|
1192
1331
|
}
|
|
1332
|
+
/**
|
|
1333
|
+
* List metadata and field names for credentials already used by connectors in the current workspace.
|
|
1334
|
+
*
|
|
1335
|
+
* @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1336
|
+
*
|
|
1337
|
+
* @example
|
|
1338
|
+
* await client.connectors.listConnectorCredentials()
|
|
1339
|
+
*/
|
|
1340
|
+
listConnectorCredentials(requestOptions) {
|
|
1341
|
+
return core.HttpResponsePromise.fromPromise(this.__listConnectorCredentials(requestOptions));
|
|
1342
|
+
}
|
|
1343
|
+
async __listConnectorCredentials(requestOptions) {
|
|
1344
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
1345
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "API-Version": requestOptions?.apiVersion ?? this._options?.apiVersion ?? "2" }), requestOptions?.headers);
|
|
1346
|
+
const _response = await core.fetcher({
|
|
1347
|
+
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
1348
|
+
(await core.Supplier.get(this._options.environment)) ??
|
|
1349
|
+
environments.HydraDBEnvironment.Default, "credential-vault"),
|
|
1350
|
+
method: "GET",
|
|
1351
|
+
headers: _headers,
|
|
1352
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
1353
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
|
1354
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
1355
|
+
abortSignal: requestOptions?.abortSignal,
|
|
1356
|
+
fetchFn: this._options?.fetch,
|
|
1357
|
+
logging: this._options.logging,
|
|
1358
|
+
});
|
|
1359
|
+
if (_response.ok) {
|
|
1360
|
+
return {
|
|
1361
|
+
data: serializers.HandlerVaultCredentialListResponse.parseOrThrow(_response.body, {
|
|
1362
|
+
unrecognizedObjectKeys: "passthrough",
|
|
1363
|
+
allowUnrecognizedUnionMembers: true,
|
|
1364
|
+
allowUnrecognizedEnumValues: true,
|
|
1365
|
+
skipValidation: true,
|
|
1366
|
+
breadcrumbsPrefix: ["response"],
|
|
1367
|
+
}),
|
|
1368
|
+
rawResponse: _response.rawResponse,
|
|
1369
|
+
};
|
|
1370
|
+
}
|
|
1371
|
+
if (_response.error.reason === "status-code") {
|
|
1372
|
+
throw new errors.HydraDBError({
|
|
1373
|
+
statusCode: _response.error.statusCode,
|
|
1374
|
+
body: _response.error.body,
|
|
1375
|
+
rawResponse: _response.rawResponse,
|
|
1376
|
+
});
|
|
1377
|
+
}
|
|
1378
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/credential-vault");
|
|
1379
|
+
}
|
|
1380
|
+
/**
|
|
1381
|
+
* Update fields on the credential currently used by a connector. Owner-only human action.
|
|
1382
|
+
*
|
|
1383
|
+
* @param {HydraDB.HandlerVaultCredentialUpdateReq} request
|
|
1384
|
+
* @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1385
|
+
*
|
|
1386
|
+
* @throws {@link HydraDB.NotFoundError}
|
|
1387
|
+
*
|
|
1388
|
+
* @example
|
|
1389
|
+
* await client.connectors.updateConnectorCredentials({
|
|
1390
|
+
* id: "HydraDoc1234",
|
|
1391
|
+
* credentials: {
|
|
1392
|
+
* "api_token": "xoxb-..."
|
|
1393
|
+
* }
|
|
1394
|
+
* })
|
|
1395
|
+
*/
|
|
1396
|
+
updateConnectorCredentials(request, requestOptions) {
|
|
1397
|
+
return core.HttpResponsePromise.fromPromise(this.__updateConnectorCredentials(request, requestOptions));
|
|
1398
|
+
}
|
|
1399
|
+
async __updateConnectorCredentials(request, requestOptions) {
|
|
1400
|
+
const { id, ..._body } = request;
|
|
1401
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
1402
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "API-Version": requestOptions?.apiVersion ?? this._options?.apiVersion ?? "2" }), requestOptions?.headers);
|
|
1403
|
+
const _response = await core.fetcher({
|
|
1404
|
+
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
1405
|
+
(await core.Supplier.get(this._options.environment)) ??
|
|
1406
|
+
environments.HydraDBEnvironment.Default, `credential-vault/${core.url.encodePathParam(id)}`),
|
|
1407
|
+
method: "PATCH",
|
|
1408
|
+
headers: _headers,
|
|
1409
|
+
contentType: "application/json",
|
|
1410
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
1411
|
+
requestType: "json",
|
|
1412
|
+
body: serializers.HandlerVaultCredentialUpdateReq.jsonOrThrow(_body, {
|
|
1413
|
+
unrecognizedObjectKeys: "strip",
|
|
1414
|
+
omitUndefined: true,
|
|
1415
|
+
}),
|
|
1416
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
|
1417
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
1418
|
+
abortSignal: requestOptions?.abortSignal,
|
|
1419
|
+
fetchFn: this._options?.fetch,
|
|
1420
|
+
logging: this._options.logging,
|
|
1421
|
+
});
|
|
1422
|
+
if (_response.ok) {
|
|
1423
|
+
return {
|
|
1424
|
+
data: serializers.HandlerVaultCredentialUpdateResponse.parseOrThrow(_response.body, {
|
|
1425
|
+
unrecognizedObjectKeys: "passthrough",
|
|
1426
|
+
allowUnrecognizedUnionMembers: true,
|
|
1427
|
+
allowUnrecognizedEnumValues: true,
|
|
1428
|
+
skipValidation: true,
|
|
1429
|
+
breadcrumbsPrefix: ["response"],
|
|
1430
|
+
}),
|
|
1431
|
+
rawResponse: _response.rawResponse,
|
|
1432
|
+
};
|
|
1433
|
+
}
|
|
1434
|
+
if (_response.error.reason === "status-code") {
|
|
1435
|
+
switch (_response.error.statusCode) {
|
|
1436
|
+
case 404:
|
|
1437
|
+
throw new HydraDB.NotFoundError(_response.error.body, _response.rawResponse);
|
|
1438
|
+
default:
|
|
1439
|
+
throw new errors.HydraDBError({
|
|
1440
|
+
statusCode: _response.error.statusCode,
|
|
1441
|
+
body: _response.error.body,
|
|
1442
|
+
rawResponse: _response.rawResponse,
|
|
1443
|
+
});
|
|
1444
|
+
}
|
|
1445
|
+
}
|
|
1446
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/credential-vault/{id}");
|
|
1447
|
+
}
|
|
1448
|
+
/**
|
|
1449
|
+
* Reveal one field from the credential currently used by a connector in the workspace. The response must never be cached.
|
|
1450
|
+
*
|
|
1451
|
+
* @param {HydraDB.HandlerVaultCredentialRevealReq} request
|
|
1452
|
+
* @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1453
|
+
*
|
|
1454
|
+
* @throws {@link HydraDB.NotFoundError}
|
|
1455
|
+
*
|
|
1456
|
+
* @example
|
|
1457
|
+
* await client.connectors.revealAConnectorCredentialValue({
|
|
1458
|
+
* id: "HydraDoc1234",
|
|
1459
|
+
* field: "field"
|
|
1460
|
+
* })
|
|
1461
|
+
*/
|
|
1462
|
+
revealAConnectorCredentialValue(request, requestOptions) {
|
|
1463
|
+
return core.HttpResponsePromise.fromPromise(this.__revealAConnectorCredentialValue(request, requestOptions));
|
|
1464
|
+
}
|
|
1465
|
+
async __revealAConnectorCredentialValue(request, requestOptions) {
|
|
1466
|
+
const { id, ..._body } = request;
|
|
1467
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
1468
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "API-Version": requestOptions?.apiVersion ?? this._options?.apiVersion ?? "2" }), requestOptions?.headers);
|
|
1469
|
+
const _response = await core.fetcher({
|
|
1470
|
+
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
1471
|
+
(await core.Supplier.get(this._options.environment)) ??
|
|
1472
|
+
environments.HydraDBEnvironment.Default, `credential-vault/${core.url.encodePathParam(id)}/reveal`),
|
|
1473
|
+
method: "POST",
|
|
1474
|
+
headers: _headers,
|
|
1475
|
+
contentType: "application/json",
|
|
1476
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
1477
|
+
requestType: "json",
|
|
1478
|
+
body: serializers.HandlerVaultCredentialRevealReq.jsonOrThrow(_body, {
|
|
1479
|
+
unrecognizedObjectKeys: "strip",
|
|
1480
|
+
omitUndefined: true,
|
|
1481
|
+
}),
|
|
1482
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
|
1483
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
1484
|
+
abortSignal: requestOptions?.abortSignal,
|
|
1485
|
+
fetchFn: this._options?.fetch,
|
|
1486
|
+
logging: this._options.logging,
|
|
1487
|
+
});
|
|
1488
|
+
if (_response.ok) {
|
|
1489
|
+
return {
|
|
1490
|
+
data: serializers.HandlerVaultCredentialRevealResponse.parseOrThrow(_response.body, {
|
|
1491
|
+
unrecognizedObjectKeys: "passthrough",
|
|
1492
|
+
allowUnrecognizedUnionMembers: true,
|
|
1493
|
+
allowUnrecognizedEnumValues: true,
|
|
1494
|
+
skipValidation: true,
|
|
1495
|
+
breadcrumbsPrefix: ["response"],
|
|
1496
|
+
}),
|
|
1497
|
+
rawResponse: _response.rawResponse,
|
|
1498
|
+
};
|
|
1499
|
+
}
|
|
1500
|
+
if (_response.error.reason === "status-code") {
|
|
1501
|
+
switch (_response.error.statusCode) {
|
|
1502
|
+
case 404:
|
|
1503
|
+
throw new HydraDB.NotFoundError(_response.error.body, _response.rawResponse);
|
|
1504
|
+
default:
|
|
1505
|
+
throw new errors.HydraDBError({
|
|
1506
|
+
statusCode: _response.error.statusCode,
|
|
1507
|
+
body: _response.error.body,
|
|
1508
|
+
rawResponse: _response.rawResponse,
|
|
1509
|
+
});
|
|
1510
|
+
}
|
|
1511
|
+
}
|
|
1512
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/credential-vault/{id}/reveal");
|
|
1513
|
+
}
|
|
1193
1514
|
}
|
|
1194
1515
|
exports.ConnectorsClient = ConnectorsClient;
|
|
@@ -25,6 +25,13 @@ export interface HandlerConfigureReq {
|
|
|
25
25
|
id: string;
|
|
26
26
|
/** Internal interval for async backfill paging. */
|
|
27
27
|
backfillChunkIntervalSeconds?: number;
|
|
28
|
+
/**
|
|
29
|
+
* FullVisibilityRoles names the HubSpot roles whose members can see every
|
|
30
|
+
* record (PRO-2036). Resolved to ids against the portal at configure time
|
|
31
|
+
* and stored on the account-wide resource row. A pointer so an omitted
|
|
32
|
+
* field keeps the current setting while an explicit [] clears it.
|
|
33
|
+
*/
|
|
34
|
+
fullVisibilityRoles?: string[];
|
|
28
35
|
/** How far back the first sync fetches historical data. Only applies to the initial sync — subsequent syncs are incremental from the last cursor. */
|
|
29
36
|
lookbackDays?: number;
|
|
30
37
|
/** Resources to activate for this connector. Each item corresponds to one entry from the Discover endpoint. */
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* id: "HydraDoc1234",
|
|
5
|
+
* credentials: {
|
|
6
|
+
* "api_token": "xoxb-..."
|
|
7
|
+
* }
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface HandlerVaultCredentialUpdateReq {
|
|
11
|
+
/** Connector ID */
|
|
12
|
+
id: string;
|
|
13
|
+
/** Provider-specific credentials (typically `{"api_token": "..."}` or `{"access_token": "..."}`). */
|
|
14
|
+
credentials: Record<string, unknown>;
|
|
15
|
+
}
|