newscatcher-catchall-sdk 1.1.2 → 1.4.0

package/dist/cjs/api/resources/datasets/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests/index.js";

package/dist/cjs/api/resources/datasets/client/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests/index.js"), exports);

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

@@ -0,0 +1,15 @@
+import type * as CatchAllApi from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
+ *         body: {
+ *             entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
+ *         }
+ *     }
+ */
+export interface AddEntitiesToDatasetRequest {
+    /** Unique dataset identifier. */
+    dataset_id: string;
+    body: CatchAllApi.DatasetEntityIdsRequest;
+}

package/dist/cjs/api/resources/datasets/client/requests/AddEntitiesToDatasetRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,16 @@
+import type * as core from "../../../../../core/index.js";
+/**
+ * @example
+ *     {
+ *         file: fs.createReadStream("/path/to/your/file"),
+ *         name: "name"
+ *     }
+ */
+export interface CreateDatasetFromCsvRequest {
+    /** The CSV file to upload. */
+    file: core.file.Uploadable;
+    /** Name for the new dataset. */
+    name: string;
+    /** Optional description for the dataset. */
+    description?: string;
+}

package/dist/cjs/api/resources/datasets/client/requests/CreateDatasetFromCsvRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,16 @@
+/**
+ * @example
+ *     {
+ *         name: "My Portfolio",
+ *         description: "Companies in our investment portfolio",
+ *         entity_ids: ["854198fa-f702-49db-a381-0427fa87f173", "a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
+ *     }
+ */
+export interface CreateDatasetRequest {
+    /** Name for the dataset. */
+    name: string;
+    /** Optional description. */
+    description?: string;
+    /** IDs of existing entities to include in the dataset. All IDs must belong to the authenticated organization. If any ID is invalid or not found, the request fails with `400`. */
+    entity_ids?: string[];
+}

package/dist/cjs/api/resources/datasets/client/requests/CreateDatasetRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+ *     }
+ */
+export interface DeleteDatasetRequest {
+    /** Unique dataset identifier. */
+    dataset_id: string;
+}

package/dist/cjs/api/resources/datasets/client/requests/DeleteDatasetRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+ *     }
+ */
+export interface GetDatasetRequest {
+    /** Unique dataset identifier. */
+    dataset_id: string;
+}

package/dist/cjs/api/resources/datasets/client/requests/GetDatasetRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+ *     }
+ */
+export interface GetDatasetStatusHistoryRequest {
+    /** Unique dataset identifier. */
+    dataset_id: string;
+}

package/dist/cjs/api/resources/datasets/client/requests/GetDatasetStatusHistoryRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,19 @@
+import type * as CatchAllApi from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         search: "Portfolio"
+ *     }
+ */
+export interface ListDatasetsRequest {
+    /** Page number to retrieve. */
+    page?: number;
+    /** Number of datasets per page. */
+    page_size?: number;
+    /** Filter datasets by name (case-insensitive substring match). */
+    search?: string;
+    /** Filter by dataset status. */
+    latest_status?: CatchAllApi.DatasetStatus;
+    sort_by?: CatchAllApi.DatasetSortBy;
+    sort_order?: CatchAllApi.SortOrder;
+}

package/dist/cjs/api/resources/datasets/client/requests/ListDatasetsRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,21 @@
+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/cjs/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,15 @@
+import type * as CatchAllApi from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
+ *         body: {
+ *             entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
+ *         }
+ *     }
+ */
+export interface RemoveEntitiesFromDatasetRequest {
+    /** Unique dataset identifier. */
+    dataset_id: string;
+    body: CatchAllApi.DatasetEntityIdsRequest;
+}

package/dist/cjs/api/resources/datasets/client/requests/RemoveEntitiesFromDatasetRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,16 @@
+/**
+ * @example
+ *     {
+ *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
+ *         name: "My Portfolio (updated)",
+ *         description: "Updated Q1 2026 watchlist"
+ *     }
+ */
+export interface UpdateDatasetRequest {
+    /** Unique dataset identifier. */
+    dataset_id: string;
+    /** Updated dataset name. */
+    name?: string;
+    /** Updated description. */
+    description?: string;
+}

package/dist/cjs/api/resources/datasets/client/requests/UpdateDatasetRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,14 @@
+import type * as core from "../../../../../core/index.js";
+/**
+ * @example
+ *     {
+ *         file: fs.createReadStream("/path/to/your/file"),
+ *         dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
+ *     }
+ */
+export interface UploadCsvToDatasetRequest {
+    /** Unique dataset identifier. */
+    dataset_id: string;
+    /** The CSV file to upload. */
+    file: core.file.Uploadable;
+}

package/dist/cjs/api/resources/datasets/client/requests/UploadCsvToDatasetRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,11 @@
+export type { AddEntitiesToDatasetRequest } from "./AddEntitiesToDatasetRequest.js";
+export type { CreateDatasetFromCsvRequest } from "./CreateDatasetFromCsvRequest.js";
+export type { CreateDatasetRequest } from "./CreateDatasetRequest.js";
+export type { DeleteDatasetRequest } from "./DeleteDatasetRequest.js";
+export type { GetDatasetRequest } from "./GetDatasetRequest.js";
+export type { GetDatasetStatusHistoryRequest } from "./GetDatasetStatusHistoryRequest.js";
+export type { ListDatasetsRequest } from "./ListDatasetsRequest.js";
+export type { ListEntitiesInDatasetRequest } from "./ListEntitiesInDatasetRequest.js";
+export type { RemoveEntitiesFromDatasetRequest } from "./RemoveEntitiesFromDatasetRequest.js";
+export type { UpdateDatasetRequest } from "./UpdateDatasetRequest.js";
+export type { UploadCsvToDatasetRequest } from "./UploadCsvToDatasetRequest.js";

package/dist/cjs/api/resources/datasets/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/datasets/exports.d.ts

@@ -0,0 +1,2 @@
+export { DatasetsClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/cjs/api/resources/datasets/exports.js

@@ -0,0 +1,21 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DatasetsClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "DatasetsClient", { enumerable: true, get: function () { return Client_js_1.DatasetsClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/datasets/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/cjs/api/resources/datasets/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/entities/client/Client.d.ts

@@ -0,0 +1,164 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as CatchAllApi from "../../../index.js";
+export declare namespace EntitiesClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Operations to create, update, and delete company entities.
+ *
+ * Entities are the building blocks of Company Search. Each entity represents
+ * a company (or person) you want to track. Add identifying information such as
+ * domain, alternative names, and key persons to improve matching quality.
+ */
+export declare class EntitiesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<EntitiesClient.Options>;
+    constructor(options?: EntitiesClient.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.
+     *
+     * @param {CatchAllApi.ListEntitiesRequest} request
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     *
+     * @example
+     *     await client.entities.listEntities({
+     *         search: "NewsCatcher"
+     *     })
+     */
+    listEntities(request?: CatchAllApi.ListEntitiesRequest, requestOptions?: EntitiesClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.EntityListResponse>;
+    private __listEntities;
+    /**
+     * Creates a new company entity and begins background enrichment.
+     *
+     * The entity status starts as `pending` and transitions to `ready` once
+     * enrichment completes. Provide as much identifying information as
+     * possible — `domain` is the highest-signal field because it is
+     * unambiguous.
+     *
+     * @param {CatchAllApi.CreateEntityRequest} request
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.BadRequestError}
+     * @throws {@link CatchAllApi.ForbiddenError}
+     *
+     * @example
+     *     await client.entities.createEntity({
+     *         name: "NewsCatcher",
+     *         entity_type: "company",
+     *         description: "AI-powered news data provider",
+     *         additional_attributes: {
+     *             company_attributes: {
+     *                 domain: "newscatcherapi.com",
+     *                 key_persons: ["Artem Bugara", "Maksym Sugonyaka"],
+     *                 alternative_names: ["NC", "NewsCatcher API"]
+     *             }
+     *         }
+     *     })
+     */
+    createEntity(request: CatchAllApi.CreateEntityRequest, requestOptions?: EntitiesClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.CreateEntityResponse>;
+    private __createEntity;
+    /**
+     * 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.
+     *
+     * @param {CatchAllApi.CreateEntitiesBatchRequest} request
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.BadRequestError}
+     * @throws {@link CatchAllApi.ForbiddenError}
+     *
+     * @example
+     *     await client.entities.createEntitiesBatch({
+     *         entities: [{
+     *                 name: "OpenAI",
+     *                 entity_type: "company",
+     *                 description: "Artificial intelligence research company",
+     *                 additional_attributes: {
+     *                     company_attributes: {
+     *                         domain: "openai.com",
+     *                         key_persons: ["Sam Altman"],
+     *                         alternative_names: ["Open AI"]
+     *                     }
+     *                 }
+     *             }, {
+     *                 name: "Stripe",
+     *                 entity_type: "company",
+     *                 description: "Online payment processing platform",
+     *                 additional_attributes: {
+     *                     company_attributes: {
+     *                         domain: "stripe.com",
+     *                         key_persons: ["Patrick Collison", "John Collison"]
+     *                     }
+     *                 }
+     *             }]
+     *     })
+     */
+    createEntitiesBatch(request: CatchAllApi.CreateEntitiesBatchRequest, requestOptions?: EntitiesClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.CreateEntitiesBatchResponse>;
+    private __createEntitiesBatch;
+    /**
+     * Returns a single entity by ID with all attributes and current status.
+     *
+     * @param {CatchAllApi.GetEntityRequest} request
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.entities.getEntity({
+     *         entity_id: "854198fa-f702-49db-a381-0427fa87f173"
+     *     })
+     */
+    getEntity(request: CatchAllApi.GetEntityRequest, requestOptions?: EntitiesClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.EntityResponse>;
+    private __getEntity;
+    /**
+     * Permanently deletes an entity. The entity is removed from all
+     * datasets and the search index. This operation cannot be undone.
+     *
+     * @param {CatchAllApi.DeleteEntityRequest} request
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.entities.deleteEntity({
+     *         entity_id: "854198fa-f702-49db-a381-0427fa87f173"
+     *     })
+     */
+    deleteEntity(request: CatchAllApi.DeleteEntityRequest, requestOptions?: EntitiesClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteEntity;
+    /**
+     * Updates one or more fields of an existing entity.
+     *
+     * @param {CatchAllApi.UpdateEntityRequest} request
+     * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.BadRequestError}
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.entities.updateEntity({
+     *         entity_id: "854198fa-f702-49db-a381-0427fa87f173",
+     *         description: "Updated description",
+     *         additional_attributes: {
+     *             company_attributes: {
+     *                 alternative_names: ["NC", "NewsCatcher API", "NCA"]
+     *             }
+     *         }
+     *     })
+     */
+    updateEntity(request: CatchAllApi.UpdateEntityRequest, requestOptions?: EntitiesClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.EntityResponse>;
+    private __updateEntity;
+}