newscatcher-catchall-sdk 1.0.0 → 1.1.2

package/dist/cjs/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.ts

@@ -2,23 +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.
      *
-     * 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/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/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

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

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

@@ -10,8 +10,7 @@ exports.EnrichmentType = void 0;
  * - `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.
  */
 exports.EnrichmentType = {
     Text: "text",
@@ -19,6 +18,5 @@ exports.EnrichmentType = {
     Date: "date",
     Option: "option",
     Url: "url",
-    Dict: "dict",
     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

@@ -1,20 +1,19 @@
 import type * as CatchAllApi from "../index.js";
-/**
- * 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;
 }

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

@@ -1,6 +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/v3/catch-all/endpoints/continue-job) to extend the limit after job completion without reprocessing.
+ * 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/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/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. */

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

@@ -4,18 +4,18 @@ export interface MonitorListItemDto {
     monitor_id: string;
     /** Job identifier used as a reference for this monitor. */
     reference_job_id: string;
-    /** Natural language query from the reference job. */
+    /** Plain text query from the reference job. */
     reference_job_query: string;
     /** Whether the monitor is currently active. */
     enabled: boolean;
     /** Cron expression for monitor schedule. */
-    schedule?: string;
-    /** Natural language description of the monitor schedule. */
-    schedule_human_readable?: string;
+    schedule?: string | undefined;
+    /** The monitor schedule in a plain text format. */
+    schedule_human_readable?: string | undefined;
     /** Timezone for schedule execution. */
-    timezone?: string;
+    timezone?: string | undefined;
     /** The date when the monitor was created. */
-    created_at?: string;
+    created_at?: string | undefined;
     /** Webhook configuration for this monitor (if set). */
-    webhook?: CatchAllApi.WebhookDto;
+    webhook?: CatchAllApi.WebhookDto | undefined;
 }

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

@@ -3,21 +3,11 @@ import type * as CatchAllApi from "../index.js";
  * Record with monitor-specific metadata. Used in monitor results and webhook payloads.
  * Includes timestamps tracking when records were added and updated, and citations include job tracking.
  */
-export interface MonitorRecord {
-    /** Unique identifier for the record. */
-    record_id: string;
-    /** Short title summarizing the record. */
-    record_title: string;
-    /**
-     * Structured data extracted from articles. Schema is dynamically generated per job. Field names are chosen semantically to match the content.
-     *
-     * See [Understanding dynamic schemas](https://www.newscatcherapi.com/docs/v3/catch-all/overview/dynamic-schemas) for integration guidance.
-     */
-    enrichment: Record<string, unknown>;
-    /** Source articles with monitor-specific metadata (job_id, added_on timestamps). */
+export interface MonitorRecord extends CatchAllApi.BaseRecord {
+    /** Source documents with monitor-specific metadata (job_id, added_on timestamps). */
     citations: CatchAllApi.MonitorCitation[];
     /** The date when this record was first added to monitor results in ISO 8601 format with UTC timezone. */
-    added_on?: string;
+    added_on?: string | undefined;
     /** The date when this record was last updated in monitor results in ISO 8601 format with UTC timezone. */
-    updated_on?: string;
+    updated_on?: string | undefined;
 }

package/dist/{esm/api/types/JobStatus.d.mts → cjs/api/types/PublicJobStatus.d.ts}

@@ -3,15 +3,15 @@
  *
  * - `submitted`: Job queued, waiting to start processing.
  * - `analyzing`: Extracting keywords, generating search queries, and creating validators/extractors.
- * - `fetching`: Retrieving articles from web sources.
- * - `clustering`: Grouping similar articles into distinct events.
+ * - `fetching`: Retrieving web pages.
+ * - `clustering`: Grouping similar web pages into clusters.
  * - `enriching`: Validating clusters and extracting structured data.
  * - `completed`: Job finished successfully, results ready.
  * - `failed`: Job processing failed.
  *
  * Poll `/catchAll/status/{job_id}` every 30-60 seconds until status is `completed` (typically 10-15 minutes).
  */
-export declare const JobStatus: {
+export declare const PublicJobStatus: {
     readonly Submitted: "submitted";
     readonly Analyzing: "analyzing";
     readonly Fetching: "fetching";
@@ -20,4 +20,4 @@ export declare const JobStatus: {
     readonly Completed: "completed";
     readonly Failed: "failed";
 };
-export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
+export type PublicJobStatus = (typeof PublicJobStatus)[keyof typeof PublicJobStatus];

package/dist/cjs/api/types/{JobStatus.js → PublicJobStatus.js}

@@ -1,21 +1,21 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.JobStatus = void 0;
+exports.PublicJobStatus = void 0;
 /**
  * Current job processing status. Jobs progress through these stages:
  *
  * - `submitted`: Job queued, waiting to start processing.
  * - `analyzing`: Extracting keywords, generating search queries, and creating validators/extractors.
- * - `fetching`: Retrieving articles from web sources.
- * - `clustering`: Grouping similar articles into distinct events.
+ * - `fetching`: Retrieving web pages.
+ * - `clustering`: Grouping similar web pages into clusters.
  * - `enriching`: Validating clusters and extracting structured data.
  * - `completed`: Job finished successfully, results ready.
  * - `failed`: Job processing failed.
  *
  * Poll `/catchAll/status/{job_id}` every 30-60 seconds until status is `completed` (typically 10-15 minutes).
  */
-exports.JobStatus = {
+exports.PublicJobStatus = {
     Submitted: "submitted",
     Analyzing: "analyzing",
     Fetching: "fetching",

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

@@ -2,44 +2,49 @@ import type * as CatchAllApi from "../index.js";
 export interface PullJobResponseDto {
     /** Job identifier. */
     job_id: string;
-    /** Original natural language query. */
-    query?: string;
+    /** Original plain text query. */
+    query?: string | undefined;
     /** Context provided with the query. */
-    context?: string;
+    context?: string | undefined;
     /** List of validation criteria applied to filter results. */
-    validators?: string[];
+    validators?: string[] | undefined;
     /**
-     * List of extracted field names generated by the enrichment process.
-     * These field names appear in the `enrichment` object of each record.
+     * List of extracted field names generated by the enrichment process. These field names appear in the `enrichment` object of each record.
+     *
+     * **Note:** The `enrichment_confidence` field always appears in this list. The system adds it to every record regardless of the enrichments generated or defined.
      */
-    enrichments?: string[];
+    enrichments?: string[] | undefined;
     /** Job status. */
-    status: string;
+    status?: string | undefined;
+    /** Error message if the job failed. Null for successful jobs. */
+    error?: (string | null) | undefined;
+    /** Record limit for this job. Reflects the value specified at submit time, or the plan default if no limit was provided. */
+    limit?: number | undefined;
     /** Total time taken to process the job. */
-    duration?: string;
-    /** Number of distinct event clusters identified before validation. */
-    candidate_records?: number;
+    duration?: string | undefined;
+    /** Total number of distinct event clusters identified. Compare with `progress_validated` to estimate how many candidates remain unprocessed for job continuation. */
+    candidate_records?: number | undefined;
     /** Number of validated records extracted. */
-    valid_records?: number;
+    valid_records?: number | undefined;
     /**
      * Number of candidate clusters that have been validated during processing.
      *
-     * The system process data in batches. This field tracks how many candidates have been checked against validation criteria so far.
+     * The system process data in batches. This field tracks how many `candidate_records` have been checked against validation criteria so far.
      */
-    progress_validated?: number;
-    date_range?: PullJobResponseDto.DateRange;
+    progress_validated?: (number | null) | undefined;
+    date_range?: PullJobResponseDto.DateRange | undefined;
     /** The current page number. */
-    page?: number;
-    /** The total number of pages available. */
-    total_pages?: number;
+    page?: number | undefined;
     /** The number of records per page. */
-    page_size?: number;
+    page_size?: number | undefined;
+    /** The total number of pages available. */
+    total_pages?: number | undefined;
     /** Array of extracted records with structured data and citations. */
-    all_records?: CatchAllApi.Record_[];
+    all_records?: CatchAllApi.Record_[] | undefined;
 }
 export declare namespace PullJobResponseDto {
     interface DateRange {
-        start_date?: string;
-        end_date?: string;
+        start_date?: string | undefined;
+        end_date?: string | undefined;
     }
 }

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

@@ -3,24 +3,24 @@ export interface PullMonitorResponseDto {
     /** Unique identifier for the monitor. */
     monitor_id: string;
     /**
-     * Parsed cron expression from the natural language schedule.
+     * The cron expression for a monitor schedule parsed from the text schedule you provide.
+     *
      * Standard cron format (minute hour day month day-of-week).
      */
-    cron_expression?: string;
+    cron_expression?: string | undefined;
     /** Timezone used for schedule execution. */
-    timezone?: string;
+    timezone?: string | undefined;
     reference_job: CatchAllApi.ReferenceJob;
     /** Execution time range for this monitor. */
-    run_info?: PullMonitorResponseDto.RunInfo;
+    run_info?: PullMonitorResponseDto.RunInfo | undefined;
     /** Total number of records collected across all monitor jobs. */
-    records?: number;
+    records?: number | undefined;
     /** Current monitor status or error message if monitor creation failed. */
     status: string;
-    /**
-     * Aggregated records from all jobs executed by this monitor.
-     * Each record includes structured data extracted from web sources with citations.
-     */
-    all_records?: CatchAllApi.MonitorRecord[];
+    /** Aggregated records from all jobs executed by this monitor. Each record includes structured data extracted from web sources with citations. */
+    all_records?: CatchAllApi.MonitorRecord[] | undefined;
+    /** Record limit applied to this monitor's jobs. */
+    limit?: (number | null) | undefined;
 }
 export declare namespace PullMonitorResponseDto {
     /**
@@ -28,8 +28,8 @@ export declare namespace PullMonitorResponseDto {
      */
     interface RunInfo {
         /** Timestamp of the first job execution. */
-        first_run?: string;
+        first_run?: string | undefined;
         /** Timestamp of the most recent job execution. */
-        last_run?: string;
+        last_run?: string | undefined;
     }
 }

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

@@ -1,5 +1,5 @@
 /**
- * Natural language question describing what to find.
+ * Plain text question describing what to find.
  *
  * The system analyzes your input to generate search queries, validators, and extractors. More specific queries produce more focused results.
  */