newscatcher-catchall-sdk 1.3.1 → 1.4.0

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

@@ -33,6 +33,62 @@ export class MonitorsClient {
     constructor(options = {}) {
         this._options = normalizeClientOptionsWithAuth(options);
     }
+    /**
+     * Returns all monitors created by the authenticated user.
+     *
+     * @param {CatchAllApi.ListMonitorsRequest} request
+     * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.monitors.listMonitors()
+     */
+    listMonitors(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listMonitors(request, requestOptions));
+    }
+    __listMonitors() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { page, page_size: pageSize } = request;
+            const _queryParams = {
+                page,
+                page_size: pageSize,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, "catchAll/monitors"),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 403:
+                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new CatchAllApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CatchAllApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/catchAll/monitors");
+        });
+    }
     /**
      * Create a scheduled monitor based on a reference job.
      *
@@ -97,44 +153,33 @@ export class MonitorsClient {
         });
     }
     /**
-     * Update the webhook configuration for an existing monitor.
+     * Retrieve aggregated results from all jobs executed by a monitor.
      *
-     * @param {CatchAllApi.UpdateMonitorRequestDto} request
+     * @param {CatchAllApi.PullMonitorResultsRequest} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link CatchAllApi.ForbiddenError}
      * @throws {@link CatchAllApi.NotFoundError}
      * @throws {@link CatchAllApi.UnprocessableEntityError}
      *
      * @example
-     *     await client.monitors.updateMonitor({
-     *         monitor_id: "monitor_id",
-     *         webhook: {
-     *             url: "https://new-endpoint.com/webhook",
-     *             method: "POST",
-     *             headers: {
-     *                 "Authorization": "Bearer new_token_xyz"
-     *             }
-     *         }
+     *     await client.monitors.pullMonitorResults({
+     *         monitor_id: "monitor_id"
      *     })
      */
-    updateMonitor(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__updateMonitor(request, requestOptions));
+    pullMonitorResults(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pullMonitorResults(request, requestOptions));
     }
-    __updateMonitor(request, requestOptions) {
+    __pullMonitorResults(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { monitor_id: monitorId } = request, _body = __rest(request, ["monitor_id"]);
+            const { monitor_id: monitorId } = request;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, `catchAll/monitors/${core.url.encodePathParam(monitorId)}`),
-                method: "PATCH",
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, `catchAll/monitors/pull/${core.url.encodePathParam(monitorId)}`),
+                method: "GET",
                 headers: _headers,
-                contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                requestType: "json",
-                body: _body,
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -146,8 +191,6 @@ export class MonitorsClient {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
-                    case 403:
-                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
                     case 422:
@@ -160,7 +203,7 @@ export class MonitorsClient {
                         });
                 }
             }
-            return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/catchAll/monitors/{monitor_id}");
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/catchAll/monitors/pull/{monitor_id}");
         });
     }
     /**
@@ -221,33 +264,38 @@ export class MonitorsClient {
         });
     }
     /**
-     * Retrieve aggregated results from all jobs executed by a monitor.
+     * Resume scheduled job execution for a monitor.
      *
-     * @param {CatchAllApi.PullMonitorResultsRequest} request
+     * @param {CatchAllApi.EnableMonitorRequestDto} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link CatchAllApi.ForbiddenError}
      * @throws {@link CatchAllApi.NotFoundError}
      * @throws {@link CatchAllApi.UnprocessableEntityError}
      *
      * @example
-     *     await client.monitors.pullMonitorResults({
-     *         monitor_id: "monitor_id"
+     *     await client.monitors.enableMonitor({
+     *         monitor_id: "monitor_id",
+     *         backfill: true
      *     })
      */
-    pullMonitorResults(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__pullMonitorResults(request, requestOptions));
+    enableMonitor(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__enableMonitor(request, requestOptions));
     }
-    __pullMonitorResults(request, requestOptions) {
+    __enableMonitor(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { monitor_id: monitorId } = request;
+            const { monitor_id: monitorId } = request, _body = __rest(request, ["monitor_id"]);
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, `catchAll/monitors/pull/${core.url.encodePathParam(monitorId)}`),
-                method: "GET",
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, `catchAll/monitors/${core.url.encodePathParam(monitorId)}/enable`),
+                method: "POST",
                 headers: _headers,
+                contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: _body,
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -259,6 +307,8 @@ export class MonitorsClient {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 403:
+                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
                     case 422:
@@ -271,7 +321,7 @@ export class MonitorsClient {
                         });
                 }
             }
-            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/catchAll/monitors/pull/{monitor_id}");
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/catchAll/monitors/{monitor_id}/enable");
         });
     }
     /**
@@ -332,9 +382,9 @@ export class MonitorsClient {
         });
     }
     /**
-     * Resume scheduled job execution for a monitor.
+     * Update the webhook configuration for an existing monitor.
      *
-     * @param {CatchAllApi.EnableMonitorRequestDto} request
+     * @param {CatchAllApi.UpdateMonitorRequestDto} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link CatchAllApi.ForbiddenError}
@@ -342,23 +392,29 @@ export class MonitorsClient {
      * @throws {@link CatchAllApi.UnprocessableEntityError}
      *
      * @example
-     *     await client.monitors.enableMonitor({
+     *     await client.monitors.updateMonitor({
      *         monitor_id: "monitor_id",
-     *         backfill: true
+     *         webhook: {
+     *             url: "https://new-endpoint.com/webhook",
+     *             method: "POST",
+     *             headers: {
+     *                 "Authorization": "Bearer new_token_xyz"
+     *             }
+     *         }
      *     })
      */
-    enableMonitor(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__enableMonitor(request, requestOptions));
+    updateMonitor(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__updateMonitor(request, requestOptions));
     }
-    __enableMonitor(request, requestOptions) {
+    __updateMonitor(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const { monitor_id: monitorId } = request, _body = __rest(request, ["monitor_id"]);
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, `catchAll/monitors/${core.url.encodePathParam(monitorId)}/enable`),
-                method: "POST",
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, `catchAll/monitors/${core.url.encodePathParam(monitorId)}`),
+                method: "PATCH",
                 headers: _headers,
                 contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -389,63 +445,7 @@ export class MonitorsClient {
                         });
                 }
             }
-            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/catchAll/monitors/{monitor_id}/enable");
-        });
-    }
-    /**
-     * Returns all monitors created by the authenticated user.
-     *
-     * @param {CatchAllApi.ListMonitorsRequest} request
-     * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link CatchAllApi.ForbiddenError}
-     * @throws {@link CatchAllApi.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.monitors.listMonitors()
-     */
-    listMonitors(request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__listMonitors(request, requestOptions));
-    }
-    __listMonitors() {
-        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { page, page_size: pageSize } = request;
-            const _queryParams = {
-                page,
-                page_size: pageSize,
-            };
-            const _authRequest = yield this._options.authProvider.getAuthRequest();
-            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, "catchAll/monitors"),
-                method: "GET",
-                headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
-                logging: this._options.logging,
-            });
-            if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 403:
-                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
-                    case 422:
-                        throw new CatchAllApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
-                    default:
-                        throw new errors.CatchAllApiError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                            rawResponse: _response.rawResponse,
-                        });
-                }
-            }
-            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/catchAll/monitors");
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/catchAll/monitors/{monitor_id}");
         });
     }
 }

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

@@ -0,0 +1,7 @@
+import type * as CatchAllApi from "../index.mjs";
+/**
+ * Additional attributes for the entity, keyed by entity type.
+ */
+export interface AdditionalAttributes {
+    company_attributes?: CatchAllApi.CompanyAttributes | undefined;
+}

package/dist/esm/api/types/AdditionalAttributes.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,17 @@
+/**
+ * Identifying attributes for a company entity. All fields are optional but improve matching quality.
+ */
+export interface CompanyAttributes {
+    /**
+     * Company website domain without protocol or trailing slash.
+     *
+     * The most reliable identifier — strongly recommended when available.
+     */
+    domain?: (string | null) | undefined;
+    /** Detailed description of the company used for matching. */
+    description?: (string | null) | undefined;
+    /** Names of key people associated with the company (founders, executives, etc.). Improves matching for articles that mention people rather than the company name. */
+    key_persons?: (string[] | null) | undefined;
+    /** Alternative names, abbreviations, or aliases. Helps resolve common variations of the company name. */
+    alternative_names?: (string[] | null) | undefined;
+}

package/dist/esm/api/types/CompanyAttributes.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,30 @@
+/**
+ * A company entity matched to a record in a Company Search 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.
+ */
+export interface ConnectedEntity {
+    /** Unique identifier of the matched entity. */
+    entity_id: string;
+    /** Name of the matched entity. */
+    name: string;
+    /**
+     * Relevance score indicating how directly the entity is associated
+     * with this event.
+     *
+     * | Score | Meaning |
+     * |-------|---------|
+     * | 10 | Direct mention, critical event (merger, CEO change, major lawsuit) |
+     * | 7–9 | Major impact (earnings, product launch, senior hire) |
+     * | 4–6 | Routine update (minor product news, mid-level changes) |
+     * | 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;
+}

package/dist/esm/api/types/ConnectedEntity.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,10 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface CreateDatasetCsvResponse {
+    /** Unique identifier of the created dataset. */
+    dataset_id: string;
+    /** Name of the created dataset. */
+    dataset_name: string;
+    /** Number of entities successfully created from the CSV. */
+    entities_created: number;
+    validation_report: CatchAllApi.ValidationReport;
+}

package/dist/esm/api/types/CreateDatasetCsvResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,7 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface CreateEntitiesBatchResponse {
+    /** Array of created entity stubs in the same order as the input. */
+    entities: CatchAllApi.CreateEntityResponse[];
+    /** Total number of entities created. */
+    count: number;
+}

package/dist/esm/api/types/CreateEntitiesBatchResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,13 @@
+import type * as CatchAllApi from "../index.mjs";
+/**
+ * Request body for creating a single entity. Only `name` is required.
+ * The more fields you provide, the better the matching quality.
+ */
+export interface CreateEntityRequest {
+    /** The company or person name. Required and must be non-empty. */
+    name: string;
+    entity_type?: CatchAllApi.EntityType | undefined;
+    /** Free-text description of the entity used for disambiguation when similar names exist. */
+    description?: string | undefined;
+    additional_attributes?: CatchAllApi.AdditionalAttributes | undefined;
+}

package/dist/esm/api/types/CreateEntityRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,6 @@
+export interface CreateEntityResponse {
+    /** Unique identifier of the created entity. */
+    id: string;
+    /** Initial status of the entity. Always `pending` immediately after creation — enrichment happens asynchronously. */
+    status: string;
+}

package/dist/esm/api/types/CreateEntityResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,4 @@
+export interface DatasetEntityIdsRequest {
+    /** List of entity IDs to add or remove. */
+    entity_ids: string[];
+}

package/dist/esm/api/types/DatasetEntityIdsRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,11 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface DatasetEntityListResponse {
+    /** Array of entity summary objects for this page. */
+    entities: CatchAllApi.EntitySummary[];
+    /** Total number of entities in the dataset. */
+    total: number;
+    /** Current page number. */
+    page: number;
+    /** Number of entities per page. */
+    page_size: number;
+}

package/dist/esm/api/types/DatasetEntityListResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,11 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface DatasetListResponse {
+    /** Array of dataset objects for this page. */
+    datasets: CatchAllApi.DatasetResponse[];
+    /** Total number of datasets matching the filter criteria. */
+    total: number;
+    /** Current page number. */
+    page: number;
+    /** Number of datasets per page. */
+    page_size: number;
+}

package/dist/esm/api/types/DatasetListResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,20 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface DatasetResponse {
+    /** Unique identifier of the dataset. */
+    id: string;
+    /** Organization that owns this dataset. */
+    organization_id: string;
+    /** Dataset name. */
+    name: string;
+    /** Optional description. */
+    description?: (string | null) | undefined;
+    /** Total number of entities in this dataset. */
+    entity_count?: number | undefined;
+    latest_status?: CatchAllApi.DatasetStatus | undefined;
+    /** ID of the user who created this dataset. */
+    created_by_user_id?: string | undefined;
+    /** ISO 8601 timestamp of when the dataset was created. Returned without timezone offset (server-local time). */
+    created_at?: string | undefined;
+    /** ISO 8601 timestamp of when the dataset was last updated. Returned without timezone offset (server-local time). */
+    updated_at?: string | undefined;
+}

package/dist/esm/api/types/DatasetResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,7 @@
+/** Fields available for sorting dataset list results. */
+export declare const DatasetSortBy: {
+    readonly Name: "name";
+    readonly CreatedAt: "created_at";
+    readonly Status: "status";
+};
+export type DatasetSortBy = (typeof DatasetSortBy)[keyof typeof DatasetSortBy];

package/dist/esm/api/types/DatasetSortBy.mjs

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Fields available for sorting dataset list results. */
+export const DatasetSortBy = {
+    Name: "name",
+    CreatedAt: "created_at",
+    Status: "status",
+};

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

@@ -0,0 +1,15 @@
+/**
+ * Processing status of a dataset.
+ *
+ * - `pending`: Dataset created, entities queued for enrichment.
+ * - `enriching`: Entities are being enriched.
+ * - `ready`: All entities enriched and indexed — ready for use in jobs.
+ * - `failed`: One or more entity enrichments failed.
+ */
+export declare const DatasetStatus: {
+    readonly Pending: "pending";
+    readonly Enriching: "enriching";
+    readonly Ready: "ready";
+    readonly Failed: "failed";
+};
+export type DatasetStatus = (typeof DatasetStatus)[keyof typeof DatasetStatus];

package/dist/esm/api/types/DatasetStatus.mjs

@@ -0,0 +1,15 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * Processing status of a dataset.
+ *
+ * - `pending`: Dataset created, entities queued for enrichment.
+ * - `enriching`: Entities are being enriched.
+ * - `ready`: All entities enriched and indexed — ready for use in jobs.
+ * - `failed`: One or more entity enrichments failed.
+ */
+export const DatasetStatus = {
+    Pending: "pending",
+    Enriching: "enriching",
+    Ready: "ready",
+    Failed: "failed",
+};

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

@@ -0,0 +1,11 @@
+import type * as CatchAllApi from "../index.mjs";
+/**
+ * A single status change event in a dataset's history.
+ */
+export interface DatasetStatusEntry {
+    status: CatchAllApi.DatasetStatus;
+    /** Additional context about the status change, if available. */
+    additional_information?: (Record<string, unknown> | null) | undefined;
+    /** ISO 8601 timestamp of when this status was set. Returned without timezone offset (server-local time). */
+    created_at?: string | undefined;
+}

package/dist/esm/api/types/DatasetStatusEntry.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,7 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface DatasetStatusHistoryResponse {
+    /** ID of the dataset. */
+    dataset_id: string;
+    /** Status change entries, ordered oldest to newest. */
+    history: CatchAllApi.DatasetStatusEntry[];
+}

package/dist/esm/api/types/DatasetStatusHistoryResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -6,7 +6,9 @@
  * - `date`: ISO format dates (YYYY-MM-DD)
  * - `option`: Enum-like fixed values (status, category)
  * - `url`: Web URLs
- * - `company`: Structured company data. Returns `source_text`, `confidence`, and `metadata`. See [Company enrichment](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/company-enrichment-dto) data model.
+ * - `company`: Structured company data. Returns `source_text`, `confidence`, and `metadata`.
+ *
+ * See [Company enrichment](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/company-enrichment-dto) data model.
  */
 export declare const EnrichmentType: {
     readonly Text: "text";

package/dist/esm/api/types/EnrichmentType.mjs

@@ -7,7 +7,9 @@
  * - `date`: ISO format dates (YYYY-MM-DD)
  * - `option`: Enum-like fixed values (status, category)
  * - `url`: Web URLs
- * - `company`: Structured company data. Returns `source_text`, `confidence`, and `metadata`. See [Company enrichment](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/company-enrichment-dto) data model.
+ * - `company`: Structured company data. Returns `source_text`, `confidence`, and `metadata`.
+ *
+ * See [Company enrichment](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/company-enrichment-dto) data model.
  */
 export const EnrichmentType = {
     Text: "text",

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

@@ -0,0 +1,11 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface EntityListResponse {
+    /** Array of entity objects for this page. */
+    entities: CatchAllApi.EntityResponse[];
+    /** Total number of entities matching the filter criteria. */
+    total: number;
+    /** Current page number. */
+    page: number;
+    /** Number of entities per page. */
+    page_size: number;
+}