newscatcher-catchall-sdk 1.3.1 → 1.4.0

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.3.1";
+exports.SDK_VERSION = "1.4.0";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "newscatcher-catchall-sdk",
-        "X-Fern-SDK-Version": "1.3.1",
-        "User-Agent": "newscatcher-catchall-sdk/1.3.1",
+        "X-Fern-SDK-Version": "1.4.0",
+        "User-Agent": "newscatcher-catchall-sdk/1.4.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/esm/Client.d.mts

@@ -1,3 +1,5 @@
+import { DatasetsClient } from "./api/resources/datasets/client/Client.mjs";
+import { EntitiesClient } from "./api/resources/entities/client/Client.mjs";
 import { JobsClient } from "./api/resources/jobs/client/Client.mjs";
 import { MetaClient } from "./api/resources/meta/client/Client.mjs";
 import { MonitorsClient } from "./api/resources/monitors/client/Client.mjs";
@@ -13,10 +15,14 @@ export declare class CatchAllApiClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<CatchAllApiClient.Options>;
     protected _jobs: JobsClient | undefined;
     protected _monitors: MonitorsClient | undefined;
+    protected _entities: EntitiesClient | undefined;
+    protected _datasets: DatasetsClient | undefined;
     protected _meta: MetaClient | undefined;
     constructor(options?: CatchAllApiClient.Options);
     get jobs(): JobsClient;
     get monitors(): MonitorsClient;
+    get entities(): EntitiesClient;
+    get datasets(): DatasetsClient;
     get meta(): MetaClient;
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

package/dist/esm/Client.mjs

@@ -8,6 +8,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import { DatasetsClient } from "./api/resources/datasets/client/Client.mjs";
+import { EntitiesClient } from "./api/resources/entities/client/Client.mjs";
 import { JobsClient } from "./api/resources/jobs/client/Client.mjs";
 import { MetaClient } from "./api/resources/meta/client/Client.mjs";
 import { MonitorsClient } from "./api/resources/monitors/client/Client.mjs";
@@ -25,6 +27,14 @@ export class CatchAllApiClient {
         var _a;
         return ((_a = this._monitors) !== null && _a !== void 0 ? _a : (this._monitors = new MonitorsClient(this._options)));
     }
+    get entities() {
+        var _a;
+        return ((_a = this._entities) !== null && _a !== void 0 ? _a : (this._entities = new EntitiesClient(this._options)));
+    }
+    get datasets() {
+        var _a;
+        return ((_a = this._datasets) !== null && _a !== void 0 ? _a : (this._datasets = new DatasetsClient(this._options)));
+    }
     get meta() {
         var _a;
         return ((_a = this._meta) !== null && _a !== void 0 ? _a : (this._meta = new MetaClient(this._options)));

package/dist/esm/api/errors/BadRequestError.d.mts

@@ -1,6 +1,5 @@
 import type * as core from "../../core/index.mjs";
 import * as errors from "../../errors/index.mjs";
-import type * as CatchAllApi from "../index.mjs";
 export declare class BadRequestError extends errors.CatchAllApiError {
-    constructor(body: CatchAllApi.Error_, rawResponse?: core.RawResponse);
+    constructor(body?: unknown, rawResponse?: core.RawResponse);
 }

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

@@ -0,0 +1,245 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as CatchAllApi from "../../../index.mjs";
+export declare namespace DatasetsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Operations to create and manage datasets of entities.
+ *
+ * A dataset is a named collection of entities — think of it as a watchlist or
+ * portfolio. Connect a dataset to a job via `connected_dataset_ids` to activate
+ * Company Search mode. Datasets can be reused across multiple jobs and monitors.
+ */
+export declare class DatasetsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<DatasetsClient.Options>;
+    constructor(options?: DatasetsClient.Options);
+    /**
+     * Returns a paginated list of datasets belonging to the authenticated
+     * organization. Supports filtering by status and sorting by name,
+     * status, or creation date.
+     *
+     * @param {CatchAllApi.ListDatasetsRequest} request
+     * @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     *
+     * @example
+     *     await client.datasets.listDatasets({
+     *         search: "Portfolio"
+     *     })
+     */
+    listDatasets(request?: CatchAllApi.ListDatasetsRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetListResponse>;
+    private __listDatasets;
+    /**
+     * Creates a new dataset from a list of existing entity IDs.
+     *
+     * If any of the provided entity IDs do not exist or do not belong to
+     * your organization, the request fails with `400`. All entity IDs must
+     * be valid before the dataset is created.
+     *
+     * To create a dataset and entities in one step, use the [`Create dataset from CSV`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/datasets/create-dataset-from-csv)
+     * endpoint instead.
+     *
+     * @param {CatchAllApi.CreateDatasetRequest} request
+     * @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.BadRequestError}
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.datasets.createDataset({
+     *         name: "My Portfolio",
+     *         description: "Companies in our investment portfolio",
+     *         entity_ids: ["854198fa-f702-49db-a381-0427fa87f173", "a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
+     *     })
+     */
+    createDataset(request: CatchAllApi.CreateDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetResponse>;
+    private __createDataset;
+    /**
+     * 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.
+     *
+     * **CSV format:**
+     * ```csv
+     * name,description,domain,alternative_names,key_persons
+     * NewsCatcher,"AI-powered news data provider",newscatcherapi.com,"NC;NewsCatcher API","Artem Bugara;Maksym Sugonyaka"
+     * OpenAI,"Artificial intelligence research company",openai.com,"Open AI","Sam Altman"
+     * ```
+     *
+     * Use semicolons (`;`) to separate multiple values in `alternative_names` and `key_persons`. Rows with empty `name` are skipped and reported in `validation_report`.
+     *
+     * **Note**: The response shape differs from the JSON dataset creation endpoint: it returns `dataset_id` (not `id`) and includes a `validation_report` with details on skipped rows.
+     *
+     * @param {CatchAllApi.CreateDatasetFromCsvRequest} request
+     * @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.datasets.createDatasetFromCsv({
+     *         file: fs.createReadStream("/path/to/your/file"),
+     *         name: "name"
+     *     })
+     */
+    createDatasetFromCsv(request: CatchAllApi.CreateDatasetFromCsvRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.CreateDatasetCsvResponse>;
+    private __createDatasetFromCsv;
+    /**
+     * Returns a single dataset by ID including entity count and current status.
+     *
+     * @param {CatchAllApi.GetDatasetRequest} request
+     * @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.datasets.getDataset({
+     *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+     *     })
+     */
+    getDataset(request: CatchAllApi.GetDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetResponse>;
+    private __getDataset;
+    /**
+     * Permanently deletes a dataset. The entities within the dataset are
+     * not deleted — only the dataset itself. This operation cannot be
+     * undone.
+     *
+     * @param {CatchAllApi.DeleteDatasetRequest} request
+     * @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.datasets.deleteDataset({
+     *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+     *     })
+     */
+    deleteDataset(request: CatchAllApi.DeleteDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteDataset;
+    /**
+     * Updates the name or description of a dataset.
+     *
+     * @param {CatchAllApi.UpdateDatasetRequest} request
+     * @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.datasets.updateDataset({
+     *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
+     *         name: "My Portfolio (updated)",
+     *         description: "Updated Q1 2026 watchlist"
+     *     })
+     */
+    updateDataset(request: CatchAllApi.UpdateDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetResponse>;
+    private __updateDataset;
+    /**
+     * Returns a paginated list of entities in a dataset. Supports filtering by status and entity type.
+     *
+     * @param {CatchAllApi.ListEntitiesInDatasetRequest} request
+     * @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.datasets.listEntitiesInDataset({
+     *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+     *     })
+     */
+    listEntitiesInDataset(request: CatchAllApi.ListEntitiesInDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetEntityListResponse>;
+    private __listEntitiesInDataset;
+    /**
+     * Adds one or more existing entities to a dataset. Returns the number of entities added.
+     *
+     * @param {CatchAllApi.AddEntitiesToDatasetRequest} request
+     * @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.datasets.addEntitiesToDataset({
+     *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
+     *         body: {
+     *             entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
+     *         }
+     *     })
+     */
+    addEntitiesToDataset(request: CatchAllApi.AddEntitiesToDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ManageEntitiesResponse>;
+    private __addEntitiesToDataset;
+    /**
+     * 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.
+     *
+     * @param {CatchAllApi.RemoveEntitiesFromDatasetRequest} request
+     * @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.datasets.removeEntitiesFromDataset({
+     *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
+     *         body: {
+     *             entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
+     *         }
+     *     })
+     */
+    removeEntitiesFromDataset(request: CatchAllApi.RemoveEntitiesFromDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ManageEntitiesResponse>;
+    private __removeEntitiesFromDataset;
+    /**
+     * Returns the full status change history for a dataset, ordered
+     * chronologically from oldest to newest.
+     *
+     * @param {CatchAllApi.GetDatasetStatusHistoryRequest} request
+     * @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.datasets.getDatasetStatusHistory({
+     *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+     *     })
+     */
+    getDatasetStatusHistory(request: CatchAllApi.GetDatasetStatusHistoryRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetStatusHistoryResponse>;
+    private __getDatasetStatusHistory;
+    /**
+     * 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.
+     *
+     * @param {CatchAllApi.UploadCsvToDatasetRequest} request
+     * @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.datasets.uploadCsvToDataset({
+     *         file: fs.createReadStream("/path/to/your/file"),
+     *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+     *     })
+     */
+    uploadCsvToDataset(request: CatchAllApi.UploadCsvToDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.UploadCsvToDatasetResponse>;
+    private __uploadCsvToDataset;
+}