Skip to content

feat: remove AggregationGetRequest class - #17

Closed
fern-api[bot] wants to merge 1 commit into
mainfrom
fern-bot/2026-03-16T18-53Z
Closed

fern-api[bot] wants to merge 1 commit into
mainfrom
fern-bot/2026-03-16T18-53Z

Conversation

@fern-api

@fern-api fern-api Bot commented Mar 16, 2026

Copy link
Copy Markdown
Contributor
  • The AggregationGetRequest class has been removed from the aggregation module. Any code that directly instantiates this class or uses its builder pattern will need to be updated to use alternative aggregation request methods provided by the API.
  • The SearchLink client and related functionality have been removed from the SDK. Applications using SearchLinkClient, AsyncSearchLinkClient, or their raw response variants will need to be updated to use alternative search methods. Additionally, several duplicate enum types used for request parameters have been consolidated.
  • The search similar functionality has been removed from the SDK. All SearchsimilarClient, AsyncSearchsimilarClient, and RawSearchsimilarClient classes and their methods are no longer available. Applications using these clients will need to be updated to remove search similar functionality or use alternative search methods.
  • The SearchSimilarGetRequest class has been removed. Applications using this class for similar article searches will need to be updated to use alternative request types or API endpoints.
  • The SearchSimilarPostRequest class has been removed from the SDK. Applications using this class for search similarity operations will need to be updated to use alternative request handling mechanisms.
  • The search similar API components have been removed from the SDK. This includes SearchSimilarGetResponse, SearchSimilarPostResponse, SearchSimilarResponseDto, FailedSearchSimilarResponseDto, and related enums. Applications using these classes will need to be updated to use alternative search functionality.
  • The SimilarArticleEntity class has been removed. Applications using this class will need to be updated to use alternative article entity types or updated API endpoints.
  • The SimilarDocument type has been removed from the SDK. Client method names have been updated for consistency: use latestHeadlines() instead of latestheadlines(), aggregationCount() instead of aggregation(), and searchByLink() instead of searchLink(). The searchsimilar() method is no longer available.
  • Breaking changes: The AggregationClient class has been renamed to AggregationCountClient and moved from the com.newscatcher.api.resources.aggregation package to com.newscatcher.api.resources.aggregationcount. All related classes including AsyncAggregationClient, request types, and response types have been similarly renamed and moved. Update your imports and class references accordingly. New feature: The Stream class now supports SSE event-level discrimination through new fromSseWithEventDiscrimination() methods for handling discriminated unions in Server-Sent Events.
  • The aggregation functionality has been moved from the aggregation package to the aggregationcount package. Update imports from com.newscatcher.api.resources.aggregation.* to com.newscatcher.api.resources.aggregationcount.*. The client class RawAggregationClient has been renamed to RawAggregationCountClient, and all related request/response classes have been updated with the new naming convention (e.g., AggregationGetRequest is now GetAggregationCountRequest). Similarly, Authors client request/response classes have been renamed for consistency (e.g., AuthorsGetRequest is now GetAuthorsRequest).
  • Breaking changes to the authors API: AuthorsGetRequest, AuthorsGetResponse, AuthorsPostRequest, and AuthorsPostResponse classes have been renamed to GetAuthorsRequest, GetAuthorsResponse, PostAuthorsRequest, and PostAuthorsResponse respectively. Update your imports and type references to use the new class names.
  • The AuthorsGetRequest class has been renamed to GetAuthorsRequest. Update your imports and instantiation code accordingly. The publishedDatePrecision parameter now accepts String values instead of enum values.
  • Several public classes have been renamed for API consistency. Replace AuthorsPostRequest with PostAuthorsRequest, AuthorsGetResponse with GetAuthorsResponse, and AuthorsPostResponse with PostAuthorsResponse. The BreakingNews client methods have been simplified from breakingNewsGet/breakingNewsPost to get/post. Additionally, theme and publishedDatePrecision parameters now accept string values instead of enum types.
  • Breaking change: BreakingNewsClient method names have been simplified. The breakingNewsGet() method has been renamed to get(), and breakingNewsPost() has been renamed to post(). Update your code to use the shorter method names - the functionality and return types remain unchanged.
  • The BreakingNewsGetRequest class has been renamed to GetBreakingNewsRequest. Additionally, the robotsCompliant parameter has been removed. Replace any references to BreakingNewsGetRequest with GetBreakingNewsRequest and remove usage of the robotsCompliant parameter.
  • Breaking changes to request and response class names. The BreakingNewsPostRequest class has been renamed to PostBreakingNewsRequest, and all LatestHeadlines* classes now follow the Get/Post prefix pattern (e.g., LatestHeadlinesGetRequest is now GetLatestHeadlinesRequest). The robotsCompliant field has been removed from breaking news requests, and theme/notTheme fields now accept String values instead of enum types. Update your imports and field references accordingly.
  • The RawLatestheadlinesClient class has been renamed to RawLatestHeadlinesClient, and all related request/response types have been updated with new naming conventions (e.g., LatestHeadlinesGetRequest is now GetLatestHeadlinesRequest). Update your imports and class references to use the new names.
  • The LatestHeadlinesGetRequest class has been renamed to GetLatestHeadlinesRequest. Update any direct references to use the new class name. The functionality remains the same, with additional optional fields for sorting and link text filtering.
  • Breaking changes to class names for consistency. The following classes have been renamed: LatestHeadlinesPostRequest → PostLatestHeadlinesRequest, LatestHeadlinesGetResponse → GetLatestHeadlinesResponse, LatestHeadlinesPostResponse → PostLatestHeadlinesResponse, SearchGetRequest → GetSearchRequest, SearchPostRequest → PostSearchRequest, SearchGetResponse → GetSearchResponse, SearchPostResponse → PostSearchResponse. Update your imports to use the new class names.
  • Breaking change: Search API request and response classes have been renamed for consistency. SearchGetRequest is now GetSearchRequest, SearchGetResponse is now GetSearchResponse, SearchPostRequest is now PostSearchRequest, and SearchPostResponse is now PostSearchResponse. Update your imports to use the new class names.
  • The SearchGetRequest class has been renamed to GetSearchRequest. Existing code using SearchGetRequest will need to be updated to use GetSearchRequest instead. Additionally, a new allLinksText parameter is now available for searching link anchor text content.
  • Breaking changes to search API classes: SearchPostRequest renamed to PostSearchRequest, SearchGetResponse renamed to GetSearchResponse, SearchPostResponse renamed to PostSearchResponse, and AsyncRawSearchLinkClient renamed to AsyncRawSearchByLinkClient. The publishedDatePrecision, theme, and notTheme parameters now accept String values instead of enum types. Update your imports and parameter usage accordingly.
  • The searchlink package has been renamed to searchbylink. Classes and methods within this package have been renamed: RawSearchLinkClient is now RawSearchByLinkClient, searchUrlGet() is now get(), and searchUrlPost() is now post(). Update your imports from com.newscatcher.api.resources.searchlink to com.newscatcher.api.resources.searchbylink and update method calls accordingly.
  • The Sources API request classes have been renamed for better consistency: SourcesGetRequest is now GetSourcesRequest and SourcesPostRequest is now PostSourcesRequest. New overloaded get() and post() methods are available that accept only RequestOptions for simpler usage when no request parameters are needed. The AdditionalSourceInfo response type now includes a robotsCompliant field showing the percentage of domain articles that comply with robots.txt scraping rules.
  • The AggregationBy type has been changed from an enum to a class with a visitor pattern. Existing code using AggregationBy enum values will need to be updated to use the new static constants (e.g., AggregationBy.DAY). The Aggregations class has been renamed to AggregationCountResponseDtoAggregations, and the Theme class has been renamed to AllLinksText. Code referencing these types will need to import the new class names.
  • The content field in ArticleEntity is now Optional<String> instead of required String. Existing code accessing this field must be updated to handle the Optional wrapper. The authors and journalists fields now use more specific types (ArticleEntityAuthors and ArticleEntityJournalists) for improved type safety. A new allLinksData field is available when using the all_links_text parameter to get detailed link information.
  • Breaking changes to article entity structure: The Authors type has been renamed to ArticleEntityAuthors and Journalists to ArticleEntityJournalists. The content field is now optional instead of required. The deprecated robotsCompliant field has been removed. Code using these types will need to be updated to use the new names and handle the optional content field.
  • Breaking changes to enum handling and type system. The ClusteringVariable, NewsDomainType, and SortBy enums have been converted to sealed classes with visitor patterns for better extensibility and unknown value handling. The NotTheme class has been renamed to BreakingNewsArticleEntityAuthors with reordered type priority. Existing code using these enums directly or pattern matching will need to be updated to use the new sealed class patterns.
  • The SDK now supports comprehensive logging configuration. Configure logging levels (DEBUG, INFO, WARN, ERROR) and provide custom logger implementations via the new logging() method on client builders. Silent by default — enable logging by setting silent(false) on LogConfig. HTTP requests and responses can now be logged with automatic redaction of sensitive headers.
  • New GetAggregationCountRequest class available for news aggregation endpoints. The request class provides comprehensive filtering options including news sources, languages, countries, date ranges, sentiment analysis, NLP features, and IPTC tagging support.
  • New SearchByLinkClient and AsyncSearchByLinkClient classes are now available, providing search-by-link functionality with both GET and POST methods. All builder classes now include additionalProperty() and additionalProperties() methods for enhanced extensibility.

Remove the AggregationGetRequest class from the aggregation module as part of API restructuring. This affects aggregation functionality that depends on this request type.

Key changes:
- Removed AggregationGetRequest class with all its properties and methods
- Removed builder pattern implementation for aggregation requests
- Removed support for 40+ query parameters including search filters, NLP features, and pagination options

🌿 Generated with Fern
@oscatcher oscatcher closed this Mar 16, 2026
@oscatcher
oscatcher deleted the fern-bot/2026-03-16T18-53Z branch March 16, 2026 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant