Repository navigation
feat!: rename ListEntitiesInDatasetRequest to ListDatasetEntitiesRequest and change listEntitiesInDataset endpoint path - #26
Merged
Conversation
…est and change listEntitiesInDataset endpoint path
The datasets client has been updated to reflect API changes: the request
type for listing entities in a dataset has been renamed from
`ListEntitiesInDatasetRequest` to `ListDatasetEntitiesRequest`, and the
underlying HTTP endpoint path has changed from `entities` to
`entities/list` (now a POST instead of GET). The method ordering in the
client has also been reorganized so that `addEntitiesToDataset` and
`removeEntitiesFromDataset` appear before `listEntitiesInDataset`.
Key changes:
- `ListEntitiesInDatasetRequest` renamed to `ListDatasetEntitiesRequest`; callers must update their import and usage
- `listEntitiesInDataset` now hits `POST /catchAll/datasets/{id}/entities/list` instead of `GET /catchAll/datasets/{id}/entities`
- `addEntitiesToDataset` now throws `UnprocessableEntityError` (HTTP 422) in addition to existing error types
- Javadoc updated to note that both `name` and `domain` columns are required in CSV uploads (previously only `name`)
🌿 Generated with Fern
oscatcher
self-requested a review
May 19, 2026 12:30
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Breaking: MAJOR because
ListEntitiesInDatasetRequestwas removed and replaced byListDatasetEntitiesRequest,listEntitiesInDataset()changed its HTTP method and path fromGET /catchAll/datasets/{id}/entitiestoPOST /catchAll/datasets/{id}/entities/list, andConnectedEntity.Builderintroduced a new mandatorytypestep — all of which break existing callers at compile time or runtime.Breaking Changes
ListEntitiesInDatasetRequest— renamed toListDatasetEntitiesRequest; update all imports and usages to the new class name.listEntitiesInDataset()— now sendsPOST /catchAll/datasets/{id}/entities/listinstead ofGET /catchAll/datasets/{id}/entities; recompile against the new SDK and update any HTTP-level integrations.ConnectedEntity.Builder— a new mandatory.type(entityType)step is now required between.relation()and.build(); update all existing builder chains accordingly.Added
ConnectedEntity.getType()— returns the entity type string for a connected entity.ConnectedEntity.getCompany()— returns anOptional<CompanyAttributes>with stored company attributes when present.SubmitRequestDto.getEdScoreMin()— new optionaled_score_minfield to set a minimum relevance score threshold for Company Watchlist mode results.CreateMonitorRequestDto.getTimezone()— new optionaltimezonefield accepting an IANA timezone identifier used as a fallback when the schedule string lacks an explicit timezone.Changed
addEntitiesToDataset()— now throwsUnprocessableEntityErroron HTTP 422 responses in addition to the existingNotFoundErroron 404.createDataset()/uploadCsvToDataset()documentation — clarifies that bothnameanddomaincolumns are required in the uploaded CSV (previously onlynamewas documented as required).Fixed
ListDatasetsRequestandListDatasetEntitiesRequest— getter methods were incorrectly annotated with@JsonIgnoreinstead of@JsonProperty, causing query parameters (page,page_size,search, etc.) to be silently dropped during serialization; now correctly annotated.See full changelog