newscatcher-catchall-sdk 0.3.1 → 1.1.2

package/dist/cjs/api/resources/monitors/client/Client.js

@@ -70,16 +70,7 @@ class MonitorsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
-     * Create a monitor that runs jobs based on a reference job with a specified schedule.
-     *
-     * **Schedule requirements:**
-     * - Minimum 24-hour interval between executions
-     * - Natural language format (e.g., "every day at 12 PM UTC", "every 48 hours")
-     *
-     * **Validation:**
-     * - 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.
@@ -88,8 +79,17 @@ 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) {
@@ -133,15 +133,7 @@ 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.
@@ -208,8 +200,7 @@ 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.
@@ -266,8 +257,7 @@ 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.
@@ -321,8 +311,7 @@ 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.
@@ -379,10 +368,9 @@ 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}
@@ -391,7 +379,8 @@ class MonitorsClient {
      *
      * @example
      *     await client.monitors.enableMonitor({
-     *         monitor_id: "monitor_id"
+     *         monitor_id: "monitor_id",
+     *         backfill: true
      *     })
      */
     enableMonitor(request, requestOptions) {
@@ -400,14 +389,17 @@ 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 = (0, headers_js_1.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,
@@ -439,6 +431,7 @@ 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}
@@ -447,19 +440,24 @@ 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 = (0, headers_js_1.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/cjs/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.ts

@@ -2,19 +2,40 @@ import type * as CatchAllApi from "../../../../index.js";
 /**
  * @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.
+     *
+     * 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/cjs/api/resources/monitors/client/requests/EnableMonitorRequestDto.d.ts

@@ -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/cjs/api/resources/monitors/client/requests/ListMonitorsRequest.d.ts

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

package/dist/cjs/api/resources/monitors/client/requests/ListMonitorsRequest.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/monitors/client/requests/UpdateMonitorRequestDto.d.ts

@@ -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/cjs/api/resources/monitors/client/requests/index.d.ts

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

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

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

package/dist/cjs/api/resources/monitors/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.MonitorsClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "MonitorsClient", { enumerable: true, get: function () { return Client_js_1.MonitorsClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/types/BaseRecord.d.ts

@@ -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/cjs/api/types/BaseRecord.js

@@ -0,0 +1,16 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseRecord = void 0;
+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 || (exports.BaseRecord = BaseRecord = {}));

package/dist/cjs/api/types/Citation.d.ts

@@ -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/cjs/api/types/CompanyEnrichmentOutput.d.ts

@@ -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/cjs/api/types/CompanyEnrichmentOutput.js

@@ -0,0 +1,16 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompanyEnrichmentOutput = void 0;
+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 || (exports.CompanyEnrichmentOutput = CompanyEnrichmentOutput = {}));

package/dist/cjs/api/types/ContinueResponseDto.d.ts

@@ -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/cjs/api/types/CreateMonitorResponseDto.d.ts

@@ -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/cjs/api/types/EndDate.d.ts

@@ -0,0 +1,8 @@
+/**
+ * End date for web search (ISO 8601 format with UTC timezone).
+ *
+ * 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/cjs/api/types/EndDate.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/types/EnrichmentSchema.d.ts

@@ -0,0 +1,13 @@
+import type * as CatchAllApi from "../index.js";
+/**
+ * Schema for a single enrichment field that extracts structured data.
+ *
+ * Enrichments are applied during the enriching stage to extract information from validated clusters.
+ */
+export interface EnrichmentSchema {
+    /** Enrichment field name (snake_case recommended). */
+    name: string;
+    /** What information this field extracts. */
+    description: string;
+    type: CatchAllApi.EnrichmentType;
+}

package/dist/cjs/api/types/EnrichmentSchema.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/types/EnrichmentType.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Canonical enrichment types supported by the system.
+ *
+ * - `text`: Free-form text strings (names, descriptions, summaries)
+ * - `number`: Numeric values (amounts, counts, percentages)
+ * - `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.
+ */
+export declare const EnrichmentType: {
+    readonly Text: "text";
+    readonly Number: "number";
+    readonly Date: "date";
+    readonly Option: "option";
+    readonly Url: "url";
+    readonly Company: "company";
+};
+export type EnrichmentType = (typeof EnrichmentType)[keyof typeof EnrichmentType];

package/dist/cjs/api/types/EnrichmentType.js

@@ -0,0 +1,22 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnrichmentType = void 0;
+/**
+ * Canonical enrichment types supported by the system.
+ *
+ * - `text`: Free-form text strings (names, descriptions, summaries)
+ * - `number`: Numeric values (amounts, counts, percentages)
+ * - `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.
+ */
+exports.EnrichmentType = {
+    Text: "text",
+    Number: "number",
+    Date: "date",
+    Option: "option",
+    Url: "url",
+    Company: "company",
+};

package/dist/cjs/api/types/Error_.d.ts

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

package/dist/cjs/api/types/InitializeResponseDto.d.ts

@@ -0,0 +1,19 @@
+import type * as CatchAllApi from "../index.js";
+export interface InitializeResponseDto {
+    /** 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 | 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[] | undefined;
+}

package/dist/cjs/api/types/InitializeResponseDto.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/types/JobStep.d.ts

@@ -1,8 +1,8 @@
 import type * as CatchAllApi from "../index.js";
 export interface JobStep {
-    status: CatchAllApi.JobStatus;
+    status: CatchAllApi.PublicJobStatus;
     /** Sequential position of this step in the pipeline (1-7). */
     order: number;
     /** Whether this step has finished processing. */
-    completed?: boolean;
+    completed: boolean;
 }

package/dist/cjs/api/types/Limit.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Maximum number of records to return. If not specified, defaults to your plan limit.
+ *
+ * Use [`POST /catchAll/continue`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/continue-job) to extend the limit after job completion without reprocessing.
+ */
+export type Limit = number;

package/dist/cjs/api/types/Limit.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/types/ListMonitorsResponseDto.d.ts

@@ -1,7 +1,13 @@
 import type * as CatchAllApi from "../index.js";
 export interface ListMonitorsResponseDto {
     /** Total number of monitors for this user. */
-    total_monitors: number;
+    total: number;
+    /** Current page number. */
+    page: number;
+    /** Number of monitors per page. */
+    page_size: number;
+    /** Total number of pages available. */
+    total_pages: number;
     /** Array of monitor summaries. */
     monitors: CatchAllApi.MonitorListItemDto[];
 }

package/dist/cjs/api/types/ListUserJobsResponseDto.d.ts

@@ -1,10 +1,13 @@
+import type * as CatchAllApi from "../index.js";
 export interface ListUserJobsResponseDto {
-    /** Job identifier. */
-    job_id: string;
-    /** The natural language query for this job. */
-    query: string;
-    /** Job creation timestamp in ISO 8601 format. */
-    created_at: string;
-    /** Current processing status of the job. */
-    status: string;
+    /** Total number of jobs for this user. */
+    total: number;
+    /** Current page number. */
+    page: number;
+    /** Number of jobs per page. */
+    page_size: number;
+    /** Total number of pages available. */
+    total_pages: number;
+    /** Array of user jobs on this page. */
+    jobs: CatchAllApi.UserJob[];
 }

package/dist/cjs/api/types/MonitorCitation.d.ts

@@ -1,16 +1,11 @@
+import type * as CatchAllApi from "../index.js";
 /**
  * Citation with monitor-specific metadata. Used in monitor results and webhook payloads.
  * Extends base citation with tracking information for job_id and timestamps.
  */
-export interface MonitorCitation {
-    /** Article identifier from News API */
+export interface MonitorCitation extends CatchAllApi.Citation {
+    /** Unique identifier of the document in the search index. */
     id: string;
-    /** Article title */
-    title: string;
-    /** URL to the source article */
-    link: string;
-    /** Article publication date in ISO 8601 format with UTC timezone. */
-    published_date: string;
     /** Job ID that found this citation. */
     job_id: string;
     /** The date when the citation was added to the record in ISO 8601 format with UTC timezone. */