newscatcher-catchall-sdk 1.5.1 → 2.0.0

package/dist/esm/api/resources/entities/client/Client.mjs

@@ -38,9 +38,7 @@ export class EntitiesClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
-     * Returns a paginated list of entities belonging to the authenticated
-     * organization. Supports filtering by status and entity type, and
-     * sorting by name, status, or creation date.
+     * Returns a paginated list of entities belonging to the authenticated organization. Supports filtering by status and entity type, and sorting by name, status, or creation date.
      *
      * @param {CatchAllApi.ListEntitiesRequest} request
      * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -174,11 +172,9 @@ export class EntitiesClient {
         });
     }
     /**
-     * Creates multiple entities in a single request. Each entity is
-     * processed independently — a failure in one does not affect others.
+     * Creates multiple entities in a single request. Each entity is processed independently — a failure in one does not affect others.
      *
-     * Returns an array of `{id, status}` objects in the same order as
-     * the input array.
+     * Returns an array of `{id, status}` objects in the same order as the input array.
      *
      * @param {CatchAllApi.CreateEntitiesBatchRequest} request
      * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/jobs/client/Client.d.mts

@@ -116,11 +116,9 @@ export declare class JobsClient {
     continueJob(request: CatchAllApi.ContinueRequestDto, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ContinueResponseDto>;
     private __continueJob;
     /**
-     * Soft-deletes a job. The job is flagged as deleted and no longer
-     * appears in list results. The underlying data is retained.
+     * Soft-deletes a job. The job is flagged as deleted and no longer appears in list results. The underlying data is retained.
      *
-     * Only the job owner can delete a job. Returns `404` if the job is not
-     * found or does not belong to the authenticated user.
+     * Only the job owner can delete a job. Returns `404` if the job is not found or does not belong to the authenticated user.
      *
      * Deleting an already-deleted job returns `200`.
      *

package/dist/esm/api/resources/jobs/client/Client.mjs

@@ -379,11 +379,9 @@ export class JobsClient {
         });
     }
     /**
-     * Soft-deletes a job. The job is flagged as deleted and no longer
-     * appears in list results. The underlying data is retained.
+     * Soft-deletes a job. The job is flagged as deleted and no longer appears in list results. The underlying data is retained.
      *
-     * Only the job owner can delete a job. Returns `404` if the job is not
-     * found or does not belong to the authenticated user.
+     * Only the job owner can delete a job. Returns `404` if the job is not found or does not belong to the authenticated user.
      *
      * Deleting an already-deleted job returns `200`.
      *

package/dist/esm/api/resources/jobs/client/requests/GetUserJobsRequest.d.mts

@@ -10,6 +10,5 @@ export interface GetUserJobsRequest {
     page_size?: number;
     /** Filter results by text (case-insensitive substring match). */
     search?: string;
-    /** Filter results by ownership. Defaults to `all`. */
     ownership?: CatchAllApi.OwnershipFilter;
 }

package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.d.mts

@@ -36,11 +36,17 @@ export interface SubmitRequestDto {
      */
     mode?: SubmitRequestDto.Mode;
     /**
-     * Dataset IDs to connect to this job. When provided, activates Company Watchlist mode — the job returns only events relevant to companies in the connected datasets with each record including a `connected_entities` array scored per company.
+     * Dataset IDs to connect to the job. When provided, this enables Company Watchlist mode — the job returns only events relevant to companies in the connected datasets. To set the minimum relevance threshold, use `ed_score_min`.
      *
      * The dataset must have `latest_status: ready` before the job is submitted. Submitting with a non-existent or inaccessible dataset ID returns `400`.
      */
     connected_dataset_ids?: string[];
+    /**
+     * The minimum relevance score a connected entity must reach for its record to be included in results.
+     *
+     * Only valid when `connected_dataset_ids` is set; otherwise ignored. Records where no connected entity meets the threshold are excluded entirely.
+     */
+    ed_score_min?: number;
 }
 export declare namespace SubmitRequestDto {
     /**

package/dist/esm/api/resources/monitors/client/Client.d.mts

@@ -38,7 +38,8 @@ export declare class MonitorsClient {
      * @example
      *     await client.monitors.createMonitor({
      *         reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
-     *         schedule: "every day at 12 PM UTC",
+     *         schedule: "every day at 12 PM",
+     *         timezone: "UTC",
      *         webhook: {
      *             url: "https://your-endpoint.com/webhook",
      *             method: "POST",

package/dist/esm/api/resources/monitors/client/Client.mjs

@@ -106,7 +106,8 @@ export class MonitorsClient {
      * @example
      *     await client.monitors.createMonitor({
      *         reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
-     *         schedule: "every day at 12 PM UTC",
+     *         schedule: "every day at 12 PM",
+     *         timezone: "UTC",
      *         webhook: {
      *             url: "https://your-endpoint.com/webhook",
      *             method: "POST",

package/dist/esm/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.mts

@@ -3,7 +3,8 @@ import type * as CatchAllApi from "../../../../index.mjs";
  * @example
  *     {
  *         reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
- *         schedule: "every day at 12 PM UTC",
+ *         schedule: "every day at 12 PM",
+ *         timezone: "UTC",
  *         webhook: {
  *             url: "https://your-endpoint.com/webhook",
  *             method: "POST",
@@ -22,12 +23,14 @@ export interface CreateMonitorRequestDto {
      * If [`backfill`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/monitors/create-monitor#body-backfill) is true, the job's `end_date` must be within the last 7 days.
      */
     reference_job_id: string;
+    /** Monitor schedule in plain text format. Minimum frequency depends on your plan. */
+    schedule: string;
     /**
-     * Monitor schedule in plain text format (e.g. 'every day at 12 PM UTC', 'every 48 hours').
+     * The IANA timezone identifier used as the fallback when the `schedule` string does not include an explicit timezone.
      *
-     * Minimum frequency depends on your plan.
+     * If the schedule includes a timezone abbreviation (for example, `"every day at 9am EST"`), the parsed timezone takes priority and this value is ignored.
      */
-    schedule: string;
+    timezone?: string;
     /** Optional webhook to receive notifications when jobs complete. */
     webhook?: CatchAllApi.WebhookDto;
     /** Maximum number of records per monitor run. If not provided, defaults to the plan limit. */

package/dist/esm/api/resources/monitors/client/requests/ListMonitorsRequest.d.mts

@@ -10,6 +10,5 @@ export interface ListMonitorsRequest {
     page_size?: number;
     /** Filter results by text (case-insensitive substring match). */
     search?: string;
-    /** Filter results by ownership. Defaults to `all`. */
     ownership?: CatchAllApi.OwnershipFilter;
 }

package/dist/esm/api/types/ConnectedEntity.d.mts

@@ -1,9 +1,8 @@
+import type * as CatchAllApi from "../index.mjs";
 /**
- * A company entity matched to a record in a Company Watchlist job, with
- * a relevance score and explanation.
+ * A company entity matched to a record in a Company Watchlist job, with a relevance score and explanation.
  *
- * Only entities with `ed_score` ≥ 1 appear in results. Entities scored
- * 0 are filtered out before the response is returned.
+ * Only entities with `ed_score` ≥ 1 appear in results. Entities scored 0 are filtered out before the response is returned. When `ed_score_min` is set at submission time, entities below that threshold are excluded.
  */
 export interface ConnectedEntity {
     /** Unique identifier of the matched entity. */
@@ -11,8 +10,7 @@ export interface ConnectedEntity {
     /** Name of the matched entity. */
     name: string;
     /**
-     * Relevance score indicating how directly the entity is associated
-     * with this event.
+     * Relevance score indicating how directly the entity is associated with this event.
      *
      * | Score | Meaning |
      * |-------|---------|
@@ -22,9 +20,14 @@ export interface ConnectedEntity {
      * | 1–3 | Indirect mention (listed with others, stock noise) |
      */
     ed_score: number;
+    /** Short explanation (up to 100 characters) of why this entity is associated with the event. */
+    relation: string;
+    /** The entity type. */
+    type: string;
     /**
-     * Short explanation (up to 100 characters) of why this entity is
-     * associated with the event.
+     * The stored attributes for this entity. Present only when attributes exist in the database.
+     *
+     * The field name matches the value of `type` — for example, `"company"` type entities have a `company` field.
      */
-    relation: string;
+    company?: CatchAllApi.CompanyAttributes | undefined;
 }

package/dist/esm/core/auth/AuthProvider.d.mts

@@ -5,3 +5,4 @@ export interface AuthProvider {
         endpointMetadata?: EndpointMetadata;
     }): Promise<AuthRequest>;
 }
+export declare function isAuthProvider(value: unknown): value is AuthProvider;

package/dist/esm/core/auth/AuthProvider.mjs

@@ -1 +1,6 @@
-export {};
+export function isAuthProvider(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        "getAuthRequest" in value &&
+        typeof value.getAuthRequest === "function");
+}

package/dist/esm/core/auth/index.d.mts

@@ -1,4 +1,4 @@
-export type { AuthProvider } from "./AuthProvider.mjs";
+export { type AuthProvider, isAuthProvider } from "./AuthProvider.mjs";
 export type { AuthRequest } from "./AuthRequest.mjs";
 export { BasicAuth } from "./BasicAuth.mjs";
 export { BearerToken } from "./BearerToken.mjs";

package/dist/esm/core/auth/index.mjs

@@ -1,3 +1,4 @@
+export { isAuthProvider } from "./AuthProvider.mjs";
 export { BasicAuth } from "./BasicAuth.mjs";
 export { BearerToken } from "./BearerToken.mjs";
 export { NoOpAuthProvider } from "./NoOpAuthProvider.mjs";

package/dist/esm/core/fetcher/requestWithRetries.mjs

@@ -11,6 +11,9 @@ const INITIAL_RETRY_DELAY = 1000; // in milliseconds
 const MAX_RETRY_DELAY = 60000; // in milliseconds
 const DEFAULT_MAX_RETRIES = 2;
 const JITTER_FACTOR = 0.2; // 20% random jitter
+function isRetryableStatusCode(statusCode) {
+    return [408, 429].includes(statusCode) || statusCode >= 500;
+}
 function addPositiveJitter(delay) {
     const jitterMultiplier = 1 + Math.random() * JITTER_FACTOR;
     return delay * jitterMultiplier;
@@ -50,7 +53,7 @@ export function requestWithRetries(requestFn_1) {
     return __awaiter(this, arguments, void 0, function* (requestFn, maxRetries = DEFAULT_MAX_RETRIES) {
         let response = yield requestFn();
         for (let i = 0; i < maxRetries; ++i) {
-            if ([408, 429].includes(response.status) || response.status >= 500) {
+            if (isRetryableStatusCode(response.status)) {
                 const delay = getRetryDelayFromHeaders(response, i);
                 yield new Promise((resolve) => setTimeout(resolve, delay));
                 response = yield requestFn();

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.5.1";
+export declare const SDK_VERSION = "2.0.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.5.1";
+export const SDK_VERSION = "2.0.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "newscatcher-catchall-sdk",
-    "version": "1.5.1",
+    "version": "2.0.0",
     "private": false,
     "repository": {
         "type": "git",
@@ -106,7 +106,7 @@
         "ts-loader": "^9.5.4",
         "vitest": "^4.1.1",
         "msw": "2.11.2",
-        "@types/node": "^18.19.70",
+        "@types/node": "^20.0.0",
         "typescript": "~5.9.3",
         "@biomejs/biome": "2.4.10"
     },

package/reference.md

@@ -407,11 +407,9 @@ await client.jobs.continueJob({
 <dl>
 <dd>
 
-Soft-deletes a job. The job is flagged as deleted and no longer
-appears in list results. The underlying data is retained.
+Soft-deletes a job. The job is flagged as deleted and no longer appears in list results. The underlying data is retained.
 
-Only the job owner can delete a job. Returns `404` if the job is not
-found or does not belong to the authenticated user.
+Only the job owner can delete a job. Returns `404` if the job is not found or does not belong to the authenticated user.
 
 Deleting an already-deleted job returns `200`.
 </dd>
@@ -559,7 +557,8 @@ Create a scheduled monitor based on a reference job.
 ```typescript
 await client.monitors.createMonitor({
     reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
-    schedule: "every day at 12 PM UTC",
+    schedule: "every day at 12 PM",
+    timezone: "UTC",
     webhook: {
         url: "https://your-endpoint.com/webhook",
         method: "POST",
@@ -1088,9 +1087,7 @@ await client.monitors.updateMonitor({
 <dl>
 <dd>
 
-Returns a paginated list of entities belonging to the authenticated
-organization. Supports filtering by status and entity type, and
-sorting by name, status, or creation date.
+Returns a paginated list of entities belonging to the authenticated organization. Supports filtering by status and entity type, and sorting by name, status, or creation date.
 </dd>
 </dl>
 </dd>
@@ -1234,11 +1231,9 @@ await client.entities.createEntity({
 <dl>
 <dd>
 
-Creates multiple entities in a single request. Each entity is
-processed independently — a failure in one does not affect others.
+Creates multiple entities in a single request. Each entity is processed independently — a failure in one does not affect others.
 
-Returns an array of `{id, status}` objects in the same order as
-the input array.
+Returns an array of `{id, status}` objects in the same order as the input array.
 </dd>
 </dl>
 </dd>
@@ -1527,9 +1522,7 @@ await client.entities.updateEntity({
 <dl>
 <dd>
 
-Returns a paginated list of datasets belonging to the authenticated
-organization. Supports filtering by status and sorting by name,
-status, or creation date.
+Returns a paginated list of datasets belonging to the authenticated organization. Supports filtering by status and sorting by name, status, or creation date.
 </dd>
 </dl>
 </dd>
@@ -1668,9 +1661,7 @@ await client.datasets.createDataset({
 <dl>
 <dd>
 
-Creates a new dataset by uploading a CSV file. Each row in the CSV
-becomes an entity. The `name` column is required; all other columns
-are optional.
+Creates a new dataset by uploading a CSV file. Each row in the CSV becomes an entity. The `name` and `domain`columns are required; all other columns are optional.
 
 **CSV format:**
 ```csv
@@ -1934,7 +1925,7 @@ await client.datasets.updateDataset({
 </dl>
 </details>
 
-<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">listEntitiesInDataset</a>({ ...params }) -> CatchAllApi.DatasetEntityListResponse</code></summary>
+<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">addEntitiesToDataset</a>({ ...params }) -> CatchAllApi.ManageEntitiesResponse</code></summary>
 <dl>
 <dd>
 
@@ -1946,7 +1937,7 @@ await client.datasets.updateDataset({
 <dl>
 <dd>
 
-Returns a paginated list of entities in a dataset. Supports filtering by status and entity type.
+Adds one or more existing entities to a dataset. Returns the number of entities added.
 </dd>
 </dl>
 </dd>
@@ -1961,8 +1952,11 @@ Returns a paginated list of entities in a dataset. Supports filtering by status
 <dd>
 
 ```typescript
-await client.datasets.listEntitiesInDataset({
-    dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+await client.datasets.addEntitiesToDataset({
+    dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
+    body: {
+        entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
+    }
 });
 
 ```
@@ -1979,7 +1973,7 @@ await client.datasets.listEntitiesInDataset({
 <dl>
 <dd>
 
-**request:** `CatchAllApi.ListEntitiesInDatasetRequest` 
+**request:** `CatchAllApi.AddEntitiesToDatasetRequest` 
     
 </dd>
 </dl>
@@ -1999,7 +1993,7 @@ await client.datasets.listEntitiesInDataset({
 </dl>
 </details>
 
-<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">addEntitiesToDataset</a>({ ...params }) -> CatchAllApi.ManageEntitiesResponse</code></summary>
+<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">removeEntitiesFromDataset</a>({ ...params }) -> CatchAllApi.ManageEntitiesResponse</code></summary>
 <dl>
 <dd>
 
@@ -2011,7 +2005,7 @@ await client.datasets.listEntitiesInDataset({
 <dl>
 <dd>
 
-Adds one or more existing entities to a dataset. Returns the number of entities added.
+Removes one or more entities from a dataset. The entities themselves are not deleted — they are only removed from this dataset. Returns the number of entities removed.
 </dd>
 </dl>
 </dd>
@@ -2026,7 +2020,7 @@ Adds one or more existing entities to a dataset. Returns the number of entities
 <dd>
 
 ```typescript
-await client.datasets.addEntitiesToDataset({
+await client.datasets.removeEntitiesFromDataset({
     dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
     body: {
         entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
@@ -2047,7 +2041,7 @@ await client.datasets.addEntitiesToDataset({
 <dl>
 <dd>
 
-**request:** `CatchAllApi.AddEntitiesToDatasetRequest` 
+**request:** `CatchAllApi.RemoveEntitiesFromDatasetRequest` 
     
 </dd>
 </dl>
@@ -2067,7 +2061,7 @@ await client.datasets.addEntitiesToDataset({
 </dl>
 </details>
 
-<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">removeEntitiesFromDataset</a>({ ...params }) -> CatchAllApi.ManageEntitiesResponse</code></summary>
+<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">listEntitiesInDataset</a>({ ...params }) -> CatchAllApi.DatasetEntityListResponse</code></summary>
 <dl>
 <dd>
 
@@ -2079,9 +2073,7 @@ await client.datasets.addEntitiesToDataset({
 <dl>
 <dd>
 
-Removes one or more entities from a dataset. The entities themselves
-are not deleted — they are only removed from this dataset. Returns
-the number of entities removed.
+Returns a paginated list of entities in a dataset. Supports filtering by status, entity type, and name search.
 </dd>
 </dl>
 </dd>
@@ -2096,11 +2088,15 @@ the number of entities removed.
 <dd>
 
 ```typescript
-await client.datasets.removeEntitiesFromDataset({
+await client.datasets.listEntitiesInDataset({
     dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
-    body: {
-        entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
-    }
+    page: 1,
+    page_size: 100,
+    search: "OpenAI",
+    status: "ready",
+    entity_type: "company",
+    sort_by: "created_at",
+    sort_order: "desc"
 });
 
 ```
@@ -2117,7 +2113,7 @@ await client.datasets.removeEntitiesFromDataset({
 <dl>
 <dd>
 
-**request:** `CatchAllApi.RemoveEntitiesFromDatasetRequest` 
+**request:** `CatchAllApi.ListDatasetEntitiesRequest` 
     
 </dd>
 </dl>
@@ -2149,8 +2145,7 @@ await client.datasets.removeEntitiesFromDataset({
 <dl>
 <dd>
 
-Returns the full status change history for a dataset, ordered
-chronologically from oldest to newest.
+Returns the full status change history for a dataset, ordered chronologically from oldest to newest.
 </dd>
 </dl>
 </dd>
@@ -2215,11 +2210,9 @@ await client.datasets.getDatasetStatusHistory({
 <dl>
 <dd>
 
-Appends new companies to an existing dataset by uploading a CSV file.
-Uses the same CSV format as the dataset creation endpoint.
+Appends new companies to an existing dataset by uploading a CSV file. Uses the same CSV format as the dataset creation endpoint.
 
-The response omits `dataset_name` compared to the create-from-CSV
-endpoint since the dataset already exists.
+The response omits `dataset_name` compared to the create-from-CSV endpoint since the dataset already exists.
 </dd>
 </dl>
 </dd>

package/dist/cjs/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.d.ts

@@ -1,21 +0,0 @@
-import type * as CatchAllApi from "../../../../index.js";
-/**
- * @example
- *     {
- *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
- *     }
- */
-export interface ListEntitiesInDatasetRequest {
-    /** Unique dataset identifier. */
-    dataset_id: string;
-    /** Page number to retrieve. */
-    page?: number;
-    /** Number of entities per page. */
-    page_size?: number;
-    /** Filter entities by name. */
-    search?: string;
-    status?: CatchAllApi.EntityStatus;
-    entity_type?: CatchAllApi.EntityType;
-    sort_by?: CatchAllApi.EntitySortBy;
-    sort_order?: CatchAllApi.SortOrder;
-}

package/dist/esm/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.d.mts

@@ -1,21 +0,0 @@
-import type * as CatchAllApi from "../../../../index.mjs";
-/**
- * @example
- *     {
- *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
- *     }
- */
-export interface ListEntitiesInDatasetRequest {
-    /** Unique dataset identifier. */
-    dataset_id: string;
-    /** Page number to retrieve. */
-    page?: number;
-    /** Number of entities per page. */
-    page_size?: number;
-    /** Filter entities by name. */
-    search?: string;
-    status?: CatchAllApi.EntityStatus;
-    entity_type?: CatchAllApi.EntityType;
-    sort_by?: CatchAllApi.EntitySortBy;
-    sort_order?: CatchAllApi.SortOrder;
-}