Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .fern/metadata.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
{
"cliVersion": "4.90.0",
"cliVersion": "5.28.2",
"generatorName": "fernapi/fern-java-sdk",
"generatorVersion": "4.4.1",
"generatorVersion": "4.8.10",
"generatorConfig": {
"publish-to": "central",
"client-class-name": "CatchAllApi",
"package-prefix": "com.newscatcher.catchall"
},
"originGitCommit": "3707beee5d0e236f2469e89f7b19c3a08efb6f95",
"originGitCommit": "22c183ea79ae5db44081d7400064d8907991d81b",
"originGitCommitIsDirty": true,
"invokedBy": "ci",
"requestedVersion": "AUTO",
"ciProvider": "unknown",
"sdkVersion": "1.5.0"
"sdkVersion": "2.0.0"
}
114 changes: 114 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
# Contributing

Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.

## Getting Started

### Prerequisites

- Java 11+
- Gradle

### Installation

Install the project dependencies:

```bash
./gradlew build
```

### Building

Build the project:

```bash
./gradlew build
```

### Testing

Run the test suite:

```bash
./gradlew test
```

### Formatting

Check and fix code style:

```bash
./gradlew spotlessApply
```

## About Generated Code

**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.

### Generated Files

The following directories contain generated code:
- `src/` - API client classes and types
- Most Java files in the project

### How to Customize

If you need to customize the SDK, you have two options:

#### Option 1: Use `.fernignore`

For custom code that should persist across SDK regenerations:

1. Create a `.fernignore` file in the project root
2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
3. Add your custom code to those files

Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.

For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).

#### Option 2: Contribute to the Generator

If you want to change how code is generated for all users of this SDK:

1. The Java SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
2. Generator code is located at `generators/java-v2/`
3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
4. Submit a pull request with your changes to the generator

This approach is best for:
- Bug fixes in generated code
- New features that would benefit all users
- Improvements to code generation patterns

## Making Changes

### Workflow

1. Create a new branch for your changes
2. Make your modifications
3. Run tests to ensure nothing breaks: `./gradlew test`
4. Run formatting: `./gradlew spotlessApply`
5. Build the project: `./gradlew build`
6. Commit your changes with a clear commit message
7. Push your branch and create a pull request

### Commit Messages

Write clear, descriptive commit messages that explain what changed and why.

### Code Style

This project uses automated code formatting. Run `./gradlew spotlessApply` before committing to ensure your code meets the project's style guidelines.

## Questions or Issues?

If you have questions or run into issues:

1. Check the [Fern documentation](https://buildwithfern.com)
2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
3. Open a new issue if your question hasn't been addressed

## License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Add the dependency in your `build.gradle` file:

```groovy
dependencies {
implementation 'com.newscatcherapi:newscatcher-catchall-sdk:1.5.0'
implementation 'com.newscatcherapi:newscatcher-catchall-sdk:2.0.0'
}
```

Expand All @@ -47,7 +47,7 @@ Add the dependency in your `pom.xml` file:
<dependency>
<groupId>com.newscatcherapi</groupId>
<artifactId>newscatcher-catchall-sdk</artifactId>
<version>1.5.0</version>
<version>2.0.0</version>
</dependency>
```

Expand Down Expand Up @@ -157,11 +157,19 @@ retry limit (default: 2). Before defaulting to exponential backoff, the SDK will
the `Retry-After` header (as either in seconds or as an HTTP date), and then the `X-RateLimit-Reset` header
(as a Unix timestamp in epoch seconds); failing both of those, it will fall back to exponential backoff.

A request is deemed retryable when any of the following HTTP status codes is returned:
Which status codes are retried depends on the `retry-status-codes` generator configuration:

**`legacy`** (current default): retries on
- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) (All server errors, including 500)

**`recommended`**: retries on
- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
- [502](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) (Bad Gateway)
- [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) (Service Unavailable)
- [504](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) (Gateway Timeout)

Use the `maxRetries` client option to configure this behavior.

Expand Down Expand Up @@ -253,3 +261,4 @@ On the other hand, contributions to the README are always very welcome!




4 changes: 2 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ java {

group = 'com.newscatcherapi'

version = '1.5.0'
version = '2.0.0'

jar {
dependsOn(":generatePomFileForMavenPublication")
Expand Down Expand Up @@ -78,7 +78,7 @@ publishing {
maven(MavenPublication) {
groupId = 'com.newscatcherapi'
artifactId = 'newscatcher-catchall-sdk'
version = '1.5.0'
version = '2.0.0'
from components.java
pom {
name = 'newscatcher'
Expand Down
16 changes: 16 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
## 2.0.0 - 2026-05-19
### Breaking Changes
* **`ListEntitiesInDatasetRequest`** — renamed to **`ListDatasetEntitiesRequest`**; update all imports and usages to the new class name.
* **`listEntitiesInDataset()`** — now sends `POST /catchAll/datasets/{id}/entities/list` instead of `GET /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 an `Optional<CompanyAttributes>` with stored company attributes when present.
* **`SubmitRequestDto.getEdScoreMin()`** — new optional `ed_score_min` field to set a minimum relevance score threshold for Company Watchlist mode results.
* **`CreateMonitorRequestDto.getTimezone()`** — new optional `timezone` field accepting an IANA timezone identifier used as a fallback when the schedule string lacks an explicit timezone.
### Changed
* **`addEntitiesToDataset()`** — now throws `UnprocessableEntityError` on HTTP 422 responses in addition to the existing `NotFoundError` on 404.
* **`createDataset()` / `uploadCsvToDataset()` documentation** — clarifies that both `name` and `domain` columns are required in the uploaded CSV (previously only `name` was documented as required).
### Fixed
* **`ListDatasetsRequest` and `ListDatasetEntitiesRequest`** — getter methods were incorrectly annotated with `@JsonIgnore` instead of `@JsonProperty`, causing query parameters (`page`, `page_size`, `search`, etc.) to be silently dropped during serialization; now correctly annotated.

## 1.5.0 - 2026-04-23
* ## [1.5.0] - 2025
### Added
Expand Down
Loading
Loading