newscatcher-catchall-sdk 1.0.0 → 1.1.2

package/dist/esm/api/resources/jobs/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { JobsClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/meta/exports.d.mts

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

package/dist/esm/api/resources/meta/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { MetaClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/meta/types/GetVersionResponse.d.mts

@@ -1,3 +1,3 @@
 export interface GetVersionResponse {
-    version?: string;
+    version?: string | undefined;
 }

package/dist/esm/api/resources/meta/types/HealthCheckResponse.d.mts

@@ -1,3 +1,3 @@
 export interface HealthCheckResponse {
-    healthy?: boolean;
+    healthy?: boolean | undefined;
 }

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

@@ -14,20 +14,7 @@ export declare class MonitorsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<MonitorsClient.Options>;
     constructor(options?: MonitorsClient.Options);
     /**
-     * Create a monitor that runs jobs based on a reference job with a specified schedule.
-     *
-     * **Reference job requirements:**
-     * - Job's `end_date` must be within the last 7 days
-     *
-     * **Schedule requirements:**
-     * - Minimum 24-hour interval between executions
-     * - Natural language format (e.g., "every day at 12 PM UTC", "every 48 hours")
-     *
-     * **Validation:**
-     * - Reference jobs older than 7 days return 400 Bad Request.
-     * - Schedules below minimum frequency return error with descriptive message.
-     * - Invalid job IDs return 400 Bad Request.
-     * - Duplicate monitors (same job already monitored) return error.
+     * Create a scheduled monitor based on a reference job.
      *
      * @param {CatchAllApi.CreateMonitorRequestDto} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -36,22 +23,23 @@ export declare class MonitorsClient {
      *
      * @example
      *     await client.monitors.createMonitor({
-     *         reference_job_id: "reference_job_id",
-     *         schedule: "every day at 12 PM UTC"
+     *         reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
+     *         schedule: "every day at 12 PM UTC",
+     *         webhook: {
+     *             url: "https://your-endpoint.com/webhook",
+     *             method: "POST",
+     *             headers: {
+     *                 "Authorization": "Bearer your_token_here"
+     *             }
+     *         },
+     *         limit: 10,
+     *         backfill: true
      *     })
      */
     createMonitor(request: CatchAllApi.CreateMonitorRequestDto, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.CreateMonitorResponseDto>;
     private __createMonitor;
     /**
-     * Update webhook configuration for an existing monitor without recreating it.
-     *
-     * **Supported updates:**
-     * - Webhook URL
-     * - HTTP method (POST/PUT)
-     * - Headers and authentication
-     * - Query parameters
-     *
-     * **Note:** Schedule and reference job cannot be modified. To change these, create a new monitor.
+     * Update the webhook configuration for an existing monitor.
      *
      * @param {CatchAllApi.UpdateMonitorRequestDto} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -75,8 +63,7 @@ export declare class MonitorsClient {
     updateMonitor(request: CatchAllApi.UpdateMonitorRequestDto, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.UpdateMonitorResponseDto>;
     private __updateMonitor;
     /**
-     * Returns all jobs associated with a monitor, sorted by start_date.
-     * Each job includes job_id, start_date, and end_date.
+     * Return all jobs executed by a monitor.
      *
      * @param {CatchAllApi.ListMonitorJobsRequest} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -92,8 +79,7 @@ export declare class MonitorsClient {
     listMonitorJobs(request: CatchAllApi.ListMonitorJobsRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListMonitorJobsResponse>;
     private __listMonitorJobs;
     /**
-     * Retrieve aggregated results from all jobs executed by this monitor.
-     * Includes monitor configuration, execution history, and all records collected.
+     * Retrieve aggregated results from all jobs executed by a monitor.
      *
      * @param {CatchAllApi.PullMonitorResultsRequest} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -109,8 +95,7 @@ export declare class MonitorsClient {
     pullMonitorResults(request: CatchAllApi.PullMonitorResultsRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.PullMonitorResponseDto>;
     private __pullMonitorResults;
     /**
-     * Disables a monitor to stop executing scheduled jobs.
-     * Validates that the provided API key is associated with the monitor.
+     * Stop scheduled job execution for a monitor.
      *
      * @param {CatchAllApi.DisableMonitorRequest} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -127,10 +112,9 @@ export declare class MonitorsClient {
     disableMonitor(request: CatchAllApi.DisableMonitorRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DisableMonitorResponse>;
     private __disableMonitor;
     /**
-     * Enables a monitor to resume executing scheduled jobs.
-     * Validates that the provided API key is associated with the monitor.
+     * Resume scheduled job execution for a monitor.
      *
-     * @param {CatchAllApi.EnableMonitorRequest} request
+     * @param {CatchAllApi.EnableMonitorRequestDto} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link CatchAllApi.ForbiddenError}
@@ -139,14 +123,16 @@ export declare class MonitorsClient {
      *
      * @example
      *     await client.monitors.enableMonitor({
-     *         monitor_id: "monitor_id"
+     *         monitor_id: "monitor_id",
+     *         backfill: true
      *     })
      */
-    enableMonitor(request: CatchAllApi.EnableMonitorRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.EnableMonitorResponse>;
+    enableMonitor(request: CatchAllApi.EnableMonitorRequestDto, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.EnableMonitorResponse>;
     private __enableMonitor;
     /**
      * Returns all monitors created by the authenticated user.
      *
+     * @param {CatchAllApi.ListMonitorsRequest} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link CatchAllApi.ForbiddenError}
@@ -155,6 +141,6 @@ export declare class MonitorsClient {
      * @example
      *     await client.monitors.listMonitors()
      */
-    listMonitors(requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListMonitorsResponseDto>;
+    listMonitors(request?: CatchAllApi.ListMonitorsRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListMonitorsResponseDto>;
     private __listMonitors;
 }

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

@@ -34,20 +34,7 @@ export class MonitorsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
-     * Create a monitor that runs jobs based on a reference job with a specified schedule.
-     *
-     * **Reference job requirements:**
-     * - Job's `end_date` must be within the last 7 days
-     *
-     * **Schedule requirements:**
-     * - Minimum 24-hour interval between executions
-     * - Natural language format (e.g., "every day at 12 PM UTC", "every 48 hours")
-     *
-     * **Validation:**
-     * - Reference jobs older than 7 days return 400 Bad Request.
-     * - Schedules below minimum frequency return error with descriptive message.
-     * - Invalid job IDs return 400 Bad Request.
-     * - Duplicate monitors (same job already monitored) return error.
+     * Create a scheduled monitor based on a reference job.
      *
      * @param {CatchAllApi.CreateMonitorRequestDto} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,8 +43,17 @@ export class MonitorsClient {
      *
      * @example
      *     await client.monitors.createMonitor({
-     *         reference_job_id: "reference_job_id",
-     *         schedule: "every day at 12 PM UTC"
+     *         reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
+     *         schedule: "every day at 12 PM UTC",
+     *         webhook: {
+     *             url: "https://your-endpoint.com/webhook",
+     *             method: "POST",
+     *             headers: {
+     *                 "Authorization": "Bearer your_token_here"
+     *             }
+     *         },
+     *         limit: 10,
+     *         backfill: true
      *     })
      */
     createMonitor(request, requestOptions) {
@@ -101,15 +97,7 @@ export class MonitorsClient {
         });
     }
     /**
-     * Update webhook configuration for an existing monitor without recreating it.
-     *
-     * **Supported updates:**
-     * - Webhook URL
-     * - HTTP method (POST/PUT)
-     * - Headers and authentication
-     * - Query parameters
-     *
-     * **Note:** Schedule and reference job cannot be modified. To change these, create a new monitor.
+     * Update the webhook configuration for an existing monitor.
      *
      * @param {CatchAllApi.UpdateMonitorRequestDto} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -176,8 +164,7 @@ export class MonitorsClient {
         });
     }
     /**
-     * Returns all jobs associated with a monitor, sorted by start_date.
-     * Each job includes job_id, start_date, and end_date.
+     * Return all jobs executed by a monitor.
      *
      * @param {CatchAllApi.ListMonitorJobsRequest} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -234,8 +221,7 @@ export class MonitorsClient {
         });
     }
     /**
-     * Retrieve aggregated results from all jobs executed by this monitor.
-     * Includes monitor configuration, execution history, and all records collected.
+     * Retrieve aggregated results from all jobs executed by a monitor.
      *
      * @param {CatchAllApi.PullMonitorResultsRequest} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -289,8 +275,7 @@ export class MonitorsClient {
         });
     }
     /**
-     * Disables a monitor to stop executing scheduled jobs.
-     * Validates that the provided API key is associated with the monitor.
+     * Stop scheduled job execution for a monitor.
      *
      * @param {CatchAllApi.DisableMonitorRequest} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -347,10 +332,9 @@ export class MonitorsClient {
         });
     }
     /**
-     * Enables a monitor to resume executing scheduled jobs.
-     * Validates that the provided API key is associated with the monitor.
+     * Resume scheduled job execution for a monitor.
      *
-     * @param {CatchAllApi.EnableMonitorRequest} request
+     * @param {CatchAllApi.EnableMonitorRequestDto} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link CatchAllApi.ForbiddenError}
@@ -359,7 +343,8 @@ export class MonitorsClient {
      *
      * @example
      *     await client.monitors.enableMonitor({
-     *         monitor_id: "monitor_id"
+     *         monitor_id: "monitor_id",
+     *         backfill: true
      *     })
      */
     enableMonitor(request, requestOptions) {
@@ -368,14 +353,17 @@ export class MonitorsClient {
     __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/${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,
@@ -407,6 +395,7 @@ export class MonitorsClient {
     /**
      * Returns all monitors created by the authenticated user.
      *
+     * @param {CatchAllApi.ListMonitorsRequest} request
      * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link CatchAllApi.ForbiddenError}
@@ -415,19 +404,24 @@ export class MonitorsClient {
      * @example
      *     await client.monitors.listMonitors()
      */
-    listMonitors(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__listMonitors(requestOptions));
+    listMonitors(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listMonitors(request, requestOptions));
     }
-    __listMonitors(requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
+    __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: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                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,

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

@@ -2,23 +2,40 @@ import type * as CatchAllApi from "../../../../index.mjs";
 /**
  * @example
  *     {
- *         reference_job_id: "reference_job_id",
- *         schedule: "every day at 12 PM UTC"
+ *         reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
+ *         schedule: "every day at 12 PM UTC",
+ *         webhook: {
+ *             url: "https://your-endpoint.com/webhook",
+ *             method: "POST",
+ *             headers: {
+ *                 "Authorization": "Bearer your_token_here"
+ *             }
+ *         },
+ *         limit: 10,
+ *         backfill: true
  *     }
  */
 export interface CreateMonitorRequestDto {
     /**
-     * Job ID to use as template for scheduled runs.
+     * Job ID to use as template for scheduled runs. Defines the query, validators, and enrichments used for each scheduled run.
      *
-     * Job's `end_date` must be within the last 7 days.
+     * 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;
     /**
-     * Natural language schedule (e.g. 'every day at 12 AM EST').
+     * Monitor schedule in plain text format (e.g. 'every day at 12 PM UTC', 'every 48 hours').
      *
-     * **Minimum frequency:** Monitors must be scheduled at least 24 hours apart.
+     * Minimum frequency depends on your plan.
      */
     schedule: 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. */
+    limit?: number;
+    /**
+     * If true, fills the data gap between the reference job's `end_date` and the first scheduled run. The reference job's `end_date` must be within the last 7 days.
+     *
+     * If false, no gap filling occurs and the first run uses the current cron window only — the reference job's age does not matter.
+     */
+    backfill?: boolean;
 }

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

@@ -0,0 +1,17 @@
+/**
+ * @example
+ *     {
+ *         monitor_id: "monitor_id",
+ *         backfill: true
+ *     }
+ */
+export interface EnableMonitorRequestDto {
+    /** Monitor identifier. */
+    monitor_id: string;
+    /**
+     * If true, fills the data gap between the last job's `end_date` and the first scheduled run after enabling. The last job's `end_date` must be within the last 7 days.
+     *
+     * If false, no gap filling occurs and the first run uses the current cron window only — the last job's age does not matter.
+     */
+    backfill?: boolean;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {}
+ */
+export interface ListMonitorsRequest {
+    /** Page number to retrieve. */
+    page?: number;
+    /** Number of records per page. */
+    page_size?: number;
+}

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

@@ -17,4 +17,6 @@ export interface UpdateMonitorRequestDto {
     monitor_id: string;
     /** Updated webhook configuration. */
     webhook?: CatchAllApi.WebhookDto;
+    /** Updated maximum number of records per monitor run. */
+    limit?: number;
 }

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

@@ -1,6 +1,7 @@
 export type { CreateMonitorRequestDto } from "./CreateMonitorRequestDto.mjs";
 export type { DisableMonitorRequest } from "./DisableMonitorRequest.mjs";
-export type { EnableMonitorRequest } from "./EnableMonitorRequest.mjs";
+export type { EnableMonitorRequestDto } from "./EnableMonitorRequestDto.mjs";
 export type { ListMonitorJobsRequest } from "./ListMonitorJobsRequest.mjs";
+export type { ListMonitorsRequest } from "./ListMonitorsRequest.mjs";
 export type { PullMonitorResultsRequest } from "./PullMonitorResultsRequest.mjs";
 export type { UpdateMonitorRequestDto } from "./UpdateMonitorRequestDto.mjs";

package/dist/esm/api/resources/monitors/exports.d.mts

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

package/dist/esm/api/resources/monitors/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { MonitorsClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

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

@@ -0,0 +1,38 @@
+export interface BaseRecord {
+    /** Unique identifier for the record. */
+    record_id: string;
+    /** Short title summarizing the record. */
+    record_title: string;
+    /**
+     * Structured data extracted from web pages. Schema is dynamically generated per job. Field names are chosen semantically to match the content.
+     *
+     * **Note:** The system always includes the `enrichment_confidence` field within the `enrichment` object, regardless of whether enrichments are generated or specified by you.
+     *
+     *  For integration guidance, see [Dynamic schemas](https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/dynamic-schemas)
+     */
+    enrichment: BaseRecord.Enrichment;
+}
+export declare namespace BaseRecord {
+    /**
+     * Structured data extracted from web pages. Schema is dynamically generated per job. Field names are chosen semantically to match the content.
+     *
+     * **Note:** The system always includes the `enrichment_confidence` field within the `enrichment` object, regardless of whether enrichments are generated or specified by you.
+     *
+     *  For integration guidance, see [Dynamic schemas](https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/dynamic-schemas)
+     */
+    interface Enrichment {
+        /** Overall confidence score for the enrichment extraction. */
+        enrichment_confidence?: (Enrichment.EnrichmentConfidence | null) | undefined;
+        /** Accepts any additional properties */
+        [key: string]: any;
+    }
+    namespace Enrichment {
+        /** Overall confidence score for the enrichment extraction. */
+        const EnrichmentConfidence: {
+            readonly Low: "low";
+            readonly Medium: "medium";
+            readonly High: "high";
+        };
+        type EnrichmentConfidence = (typeof EnrichmentConfidence)[keyof typeof EnrichmentConfidence];
+    }
+}

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

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+export var BaseRecord;
+(function (BaseRecord) {
+    let Enrichment;
+    (function (Enrichment) {
+        /** Overall confidence score for the enrichment extraction. */
+        Enrichment.EnrichmentConfidence = {
+            Low: "low",
+            Medium: "medium",
+            High: "high",
+        };
+    })(Enrichment = BaseRecord.Enrichment || (BaseRecord.Enrichment = {}));
+})(BaseRecord || (BaseRecord = {}));

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

@@ -1,8 +1,8 @@
 export interface Citation {
-    /** Article title */
+    /** The title of the source document. */
     title: string;
-    /** URL to the source article */
+    /** URL to the source document. */
     link: string;
-    /** Article publication date in ISO 8601 format with UTC timezone. */
+    /** The publication date of the source document in ISO 8601 format (UTC timezone). */
     published_date: string;
 }

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

@@ -0,0 +1,29 @@
+/**
+ * Appears as the value of company-typed fields in the `enrichment` object of each record. The `metadata` sub-object is populated by the system based on the identified company.
+ */
+export interface CompanyEnrichmentOutput {
+    /** The text span in the source document where the company was identified. */
+    source_text: string;
+    /** Confidence score for the company identification. */
+    confidence: number;
+    metadata: CompanyEnrichmentOutput.Metadata;
+}
+export declare namespace CompanyEnrichmentOutput {
+    interface Metadata {
+        /** Normalized company name. */
+        name: string;
+        /** Company website domain if resolved, otherwise null. */
+        domain_url?: (string | null) | undefined;
+        /** Confidence level for the domain URL resolution. */
+        domain_url_confidence?: (Metadata.DomainUrlConfidence | null) | undefined;
+    }
+    namespace Metadata {
+        /** Confidence level for the domain URL resolution. */
+        const DomainUrlConfidence: {
+            readonly Low: "low";
+            readonly Medium: "medium";
+            readonly High: "high";
+        };
+        type DomainUrlConfidence = (typeof DomainUrlConfidence)[keyof typeof DomainUrlConfidence];
+    }
+}

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

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CompanyEnrichmentOutput;
+(function (CompanyEnrichmentOutput) {
+    let Metadata;
+    (function (Metadata) {
+        /** Confidence level for the domain URL resolution. */
+        Metadata.DomainUrlConfidence = {
+            Low: "low",
+            Medium: "medium",
+            High: "high",
+        };
+    })(Metadata = CompanyEnrichmentOutput.Metadata || (CompanyEnrichmentOutput.Metadata = {}));
+})(CompanyEnrichmentOutput || (CompanyEnrichmentOutput = {}));

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

@@ -2,9 +2,9 @@ export interface ContinueResponseDto {
     /** Job identifier for the continued job. */
     job_id: string;
     /** Previous record limit before continuation. */
-    previous_limit?: number;
+    previous_limit?: number | undefined;
     /** New record limit after continuation. */
     new_limit: number;
     /** Confirmation that the continuation request was accepted. */
-    status?: string;
+    status: string;
 }

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

@@ -1,6 +1,6 @@
 export interface CreateMonitorResponseDto {
     /** Monitor ID if successful, null if error. */
-    monitor_id?: string;
+    monitor_id?: (string | null) | undefined;
     /** Creation status or error message */
     status: string;
 }

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

@@ -1,6 +1,8 @@
 /**
- * End of date range for article search (ISO 8601 format with UTC timezone).
+ * End date for web search (ISO 8601 format with UTC timezone).
  *
- * Must be within plan's allowed lookback period and after start_date. Default is current date if not specified.
+ * Defines the end of the search window by web page discovery date, not event date. Web pages discovered within this range may describe events from any time period.
+ *
+ * Must be within plan's allowed search depth and after start_date. Default is current date if not specified.
  */
 export type EndDate = string;

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

@@ -6,8 +6,7 @@
  * - `date`: ISO format dates (YYYY-MM-DD)
  * - `option`: Enum-like fixed values (status, category)
  * - `url`: Web URLs
- * - `dict`: Complex structured objects
- * - `company`: Structured company data (name, alternative_names, website_candidates, people, address)
+ * - `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";
@@ -15,7 +14,6 @@ export declare const EnrichmentType: {
     readonly Date: "date";
     readonly Option: "option";
     readonly Url: "url";
-    readonly Dict: "dict";
     readonly Company: "company";
 };
 export type EnrichmentType = (typeof EnrichmentType)[keyof typeof EnrichmentType];

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

@@ -7,8 +7,7 @@
  * - `date`: ISO format dates (YYYY-MM-DD)
  * - `option`: Enum-like fixed values (status, category)
  * - `url`: Web URLs
- * - `dict`: Complex structured objects
- * - `company`: Structured company data (name, alternative_names, website_candidates, people, address)
+ * - `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",
@@ -16,6 +15,5 @@ export const EnrichmentType = {
     Date: "date",
     Option: "option",
     Url: "url",
-    Dict: "dict",
     Company: "company",
 };

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

@@ -1,4 +1,4 @@
 export interface Error_ {
     /** Error message. */
-    detail?: string;
+    detail?: string | undefined;
 }

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

@@ -1,20 +1,19 @@
 import type * as CatchAllApi from "../index.mjs";
-/**
- * Suggestions for validators, enrichments, and date ranges based on query analysis.
- *
- * Date ranges are validated against plan limits and adjusted if necessary.
- */
 export interface InitializeResponseDto {
-    /** Suggested validators for filtering relevant articles. */
+    /** Echo of the query from the request. */
+    query: string;
+    /** Echo of the context from the request. Null if not provided. */
+    context?: (string | null) | undefined;
+    /** Suggested validators for filtering relevant web pages. */
     validators: CatchAllApi.ValidatorSchema[];
     /** Suggested enrichment fields for data extraction. */
     enrichments: CatchAllApi.EnrichmentSchema[];
-    start_date: CatchAllApi.StartDate;
-    end_date: CatchAllApi.EndDate;
+    start_date?: CatchAllApi.StartDate | undefined;
+    end_date?: CatchAllApi.EndDate | undefined;
     /**
      * Messages explaining date adjustments due to plan limits.
      *
      * Empty array if no modifications were needed. Contains human-readable messages when requested dates exceed plan's allowed lookback period.
      */
-    date_modification_message?: string[];
+    date_modification_message?: string[] | undefined;
 }