newscatcher-catchall-sdk 0.1.0

package/dist/esm/api/resources/monitors/client/requests/PullMonitorResultsRequest.mjs

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

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

@@ -0,0 +1,5 @@
+export type { CreateMonitorRequestDto } from "./CreateMonitorRequestDto.mjs";
+export type { DisableMonitorRequest } from "./DisableMonitorRequest.mjs";
+export type { EnableMonitorRequest } from "./EnableMonitorRequest.mjs";
+export type { ListMonitorJobsRequest } from "./ListMonitorJobsRequest.mjs";
+export type { PullMonitorResultsRequest } from "./PullMonitorResultsRequest.mjs";

package/dist/esm/api/resources/monitors/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./types/index.mjs";

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

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/monitors/types/DisableMonitorResponse.d.mts

@@ -0,0 +1,8 @@
+export interface DisableMonitorResponse {
+    /** Whether the operation succeeded. */
+    success: boolean;
+    /** Human-readable success message. */
+    message: string;
+    /** ID of the disabled monitor. */
+    monitor_id: string;
+}

package/dist/esm/api/resources/monitors/types/DisableMonitorResponse.mjs

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

package/dist/esm/api/resources/monitors/types/EnableMonitorResponse.d.mts

@@ -0,0 +1,8 @@
+export interface EnableMonitorResponse {
+    /** Whether the operation succeeded. */
+    success: boolean;
+    /** Human-readable success message. */
+    message: string;
+    /** ID of the enabled monitor. */
+    monitor_id: string;
+}

package/dist/esm/api/resources/monitors/types/EnableMonitorResponse.mjs

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

package/dist/esm/api/resources/monitors/types/ListMonitorJobsRequestSort.d.mts

@@ -0,0 +1,5 @@
+export declare const ListMonitorJobsRequestSort: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type ListMonitorJobsRequestSort = (typeof ListMonitorJobsRequestSort)[keyof typeof ListMonitorJobsRequestSort];

package/dist/esm/api/resources/monitors/types/ListMonitorJobsRequestSort.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+export const ListMonitorJobsRequestSort = {
+    Asc: "asc",
+    Desc: "desc",
+};

package/dist/esm/api/resources/monitors/types/ListMonitorJobsResponse.d.mts

@@ -0,0 +1,19 @@
+import type * as CatchAllApi from "../../../index.mjs";
+export interface ListMonitorJobsResponse {
+    /** Monitor identifier. */
+    monitor_id: string;
+    /** Sort order applied to results. */
+    sort_order: ListMonitorJobsResponse.SortOrder;
+    /** Total number of jobs for this monitor. */
+    total_jobs: number;
+    /** Array of job executions for this monitor. */
+    jobs: CatchAllApi.MonitorJobItem[];
+}
+export declare namespace ListMonitorJobsResponse {
+    /** Sort order applied to results. */
+    const SortOrder: {
+        readonly Asc: "asc";
+        readonly Desc: "desc";
+    };
+    type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
+}

package/dist/esm/api/resources/monitors/types/ListMonitorJobsResponse.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var ListMonitorJobsResponse;
+(function (ListMonitorJobsResponse) {
+    /** Sort order applied to results. */
+    ListMonitorJobsResponse.SortOrder = {
+        Asc: "asc",
+        Desc: "desc",
+    };
+})(ListMonitorJobsResponse || (ListMonitorJobsResponse = {}));

package/dist/esm/api/resources/monitors/types/index.d.mts

@@ -0,0 +1,4 @@
+export * from "./DisableMonitorResponse.mjs";
+export * from "./EnableMonitorResponse.mjs";
+export * from "./ListMonitorJobsRequestSort.mjs";
+export * from "./ListMonitorJobsResponse.mjs";

package/dist/esm/api/resources/monitors/types/index.mjs

@@ -0,0 +1,4 @@
+export * from "./DisableMonitorResponse.mjs";
+export * from "./EnableMonitorResponse.mjs";
+export * from "./ListMonitorJobsRequestSort.mjs";
+export * from "./ListMonitorJobsResponse.mjs";

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

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

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * Additional context to focus on specific aspects of your query.
+ */
+export type Context = string;

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ * - `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: {
+    readonly Submitted: "submitted";
+    readonly Analyzing: "analyzing";
+    readonly Fetching: "fetching";
+    readonly Clustering: "clustering";
+    readonly Enriching: "enriching";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+};
+export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];

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

@@ -0,0 +1,23 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * 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.
+ * - `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 const JobStatus = {
+    Submitted: "submitted",
+    Analyzing: "analyzing",
+    Fetching: "fetching",
+    Clustering: "clustering",
+    Enriching: "enriching",
+    Completed: "completed",
+    Failed: "failed",
+};

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

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

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

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

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

@@ -0,0 +1,7 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface ListMonitorsResponseDto {
+    /** Total number of monitors for this user. */
+    total_monitors: number;
+    /** Array of monitor summaries. */
+    monitors: CatchAllApi.MonitorListItemDto[];
+}

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

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

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

@@ -0,0 +1,6 @@
+export interface ListUserJobsResponseDto {
+    /** Job identifier. */
+    job_id: string;
+    /** The natural language query for this job. */
+    query: string;
+}

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * 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 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. */
+    added_on: string;
+}

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

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

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

@@ -0,0 +1,8 @@
+export interface MonitorJobItem {
+    /** Unique identifier for this job execution. */
+    job_id: string;
+    /** Start of the data collection time window for this job execution (based on monitor schedule) in ISO 8601 format with UTC timezone. */
+    start_date: string;
+    /** End of the data collection time window for this job execution (based on monitor schedule) in ISO 8601 format with UTC timezone. */
+    end_date: string;
+}

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

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

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

@@ -0,0 +1,16 @@
+export interface MonitorListItemDto {
+    /** Monitor identifier. */
+    monitor_id: string;
+    /** Job identifier used as a reference for this monitor. */
+    reference_job_id: string;
+    /** Natural language query from the reference job. */
+    reference_job_query: string;
+    /** Whether the monitor is currently active. */
+    enabled: boolean;
+    /** Cron expression for monitor schedule. */
+    schedule?: string;
+    /** Timezone for schedule execution. */
+    timezone?: string;
+    /** The date when the monitor was created. */
+    created_at?: string;
+}

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

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

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

@@ -0,0 +1,23 @@
+import type * as CatchAllApi from "../index.mjs";
+/**
+ * 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). */
+    citations: CatchAllApi.MonitorCitation[];
+    /** The date when this record was first added to monitor results in ISO 8601 format with UTC timezone. */
+    added_on?: string;
+    /** The date when this record was last updated in monitor results in ISO 8601 format with UTC timezone. */
+    updated_on?: string;
+}

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

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

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

@@ -0,0 +1,34 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface PullJobResponseDto {
+    /** Job identifier. */
+    job_id: string;
+    /** Original natural language query. */
+    query?: string;
+    /** Context provided with the query. */
+    context?: string;
+    /** List of validation criteria applied to filter results. */
+    validators?: string[];
+    /** Job status. */
+    status: string;
+    /** Total time taken to process the job. */
+    duration?: string;
+    /** Number of candidate records before validation. */
+    candidate_records?: number;
+    /** Number of validated records extracted. */
+    valid_records?: number;
+    date_range?: PullJobResponseDto.DateRange;
+    /** The current page number. */
+    page?: number;
+    /** The total number of pages available. */
+    total_pages?: number;
+    /** The number of records per page. */
+    page_size?: number;
+    /** Array of extracted records with structured data and citations. */
+    all_records?: CatchAllApi.Record_[];
+}
+export declare namespace PullJobResponseDto {
+    interface DateRange {
+        start_date?: string;
+        end_date?: string;
+    }
+}

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

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

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

@@ -0,0 +1,35 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface PullMonitorResponseDto {
+    /** Unique identifier for the monitor. */
+    monitor_id: string;
+    /**
+     * Parsed cron expression from the natural language schedule.
+     * Standard cron format (minute hour day month day-of-week).
+     */
+    cron_expression?: string;
+    /** Timezone used for schedule execution. */
+    timezone?: string;
+    reference_job: CatchAllApi.ReferenceJob;
+    /** Execution time range for this monitor. */
+    run_info?: PullMonitorResponseDto.RunInfo;
+    /** Total number of records collected across all monitor jobs. */
+    records?: number;
+    /** 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[];
+}
+export declare namespace PullMonitorResponseDto {
+    /**
+     * Execution time range for this monitor.
+     */
+    interface RunInfo {
+        /** Timestamp of the first job execution. */
+        first_run?: string;
+        /** Timestamp of the most recent job execution. */
+        last_run?: string;
+    }
+}

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

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

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

@@ -0,0 +1,6 @@
+/**
+ * Natural language question describing what to find.
+ *
+ * The system analyzes your input to generate search queries, validators, and extractors. More specific queries produce more focused results.
+ */
+export type Query = string;

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

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

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

@@ -0,0 +1,15 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface Record_ {
+    /** 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 that were used to extract this record. */
+    citations: CatchAllApi.Citation[];
+}

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

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

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

@@ -0,0 +1,6 @@
+export interface ReferenceJob {
+    /** Natural language query from the reference job. */
+    query?: string;
+    /** Context provided with the reference job query. */
+    context?: string;
+}

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

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

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

@@ -0,0 +1,6 @@
+/**
+ * Template string to guide record summary formatting. Use placeholder syntax with brackets to indicate desired fields: [COMPANY], [REVENUE], [DATE], etc.
+ *
+ * When provided, the system generates a `schema_based_summary` field for each record following this template.
+ */
+export type Schema = string;

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

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

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

@@ -0,0 +1,9 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface StatusResponseDto {
+    /** Job identifier. */
+    job_id: string;
+    /** Internal job processing status. Use the `steps` array for reliable status tracking. */
+    status?: string;
+    /** Detailed progress tracking for each processing stage. Steps progress sequentially from order 1 (submitted) through 5 (enriching), ending at order 6 (completed) or 7 (failed). */
+    steps: CatchAllApi.JobStep[];
+}

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

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

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

@@ -0,0 +1,4 @@
+export interface SubmitResponseBody {
+    /** Unique identifier for the created job. Use this to check status and retrieve results. */
+    job_id: string;
+}

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

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

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

@@ -0,0 +1,14 @@
+export interface ValidationErrorDetail {
+    /** Location of the validation error */
+    loc?: ValidationErrorDetail.Loc.Item[];
+    /** Error message */
+    msg?: string;
+    /** Error type */
+    type?: string;
+}
+export declare namespace ValidationErrorDetail {
+    type Loc = Loc.Item[];
+    namespace Loc {
+        type Item = string | number;
+    }
+}

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

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

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

@@ -0,0 +1,4 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface ValidationErrorResponse {
+    detail?: CatchAllApi.ValidationErrorDetail[];
+}

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

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

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

@@ -0,0 +1,20 @@
+export interface WebhookDto {
+    /** Webhook endpoint URL. */
+    url: string;
+    /** HTTP method to use. */
+    method?: WebhookDto.Method;
+    /** HTTP headers to include in request. */
+    headers?: Record<string, string>;
+    /** Query string parameters. */
+    params?: Record<string, unknown>;
+    /** Basic auth credentials [username, password]. */
+    auth?: string[];
+}
+export declare namespace WebhookDto {
+    /** HTTP method to use. */
+    const Method: {
+        readonly Post: "POST";
+        readonly Put: "PUT";
+    };
+    type Method = (typeof Method)[keyof typeof Method];
+}

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

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var WebhookDto;
+(function (WebhookDto) {
+    /** HTTP method to use. */
+    WebhookDto.Method = {
+        Post: "POST",
+        Put: "PUT",
+    };
+})(WebhookDto || (WebhookDto = {}));

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

@@ -0,0 +1,28 @@
+import type * as CatchAllApi from "../index.mjs";
+/**
+ * Payload sent to webhook URL when a monitor job completes.
+ * Content-Type: application/json
+ *
+ * Note: Citations in webhook payloads include an additional 'id' field
+ * (string, internal identifier) not present in API GET responses.
+ */
+export interface WebhookPayload {
+    /** Monitor identifier. */
+    monitor_id?: string;
+    /** Reference job used as template for this monitor. */
+    reference_job_id?: string;
+    /** Job ID of the most recent execution. */
+    latest_job_id?: string;
+    /** Number of new records from latest job (after deduplication). */
+    records_count?: number;
+    /** Total number of jobs executed by this monitor. */
+    jobs_processed?: number;
+    /** The date when the webhook was triggered in ISO 8601 format with UTC timezone. */
+    updated_at?: string;
+    /** Cron expression defining the monitor schedule. */
+    cron_expression?: string;
+    /** Timezone for schedule execution. */
+    timezone?: string;
+    /** Array of new records from the latest job execution (includes monitor-specific fields like added_on, updated_on). */
+    records?: CatchAllApi.MonitorRecord[];
+}

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

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

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

@@ -0,0 +1,24 @@
+export * from "./Citation.mjs";
+export * from "./Context.mjs";
+export * from "./CreateMonitorResponseDto.mjs";
+export * from "./Error_.mjs";
+export * from "./JobStatus.mjs";
+export * from "./JobStep.mjs";
+export * from "./ListMonitorsResponseDto.mjs";
+export * from "./ListUserJobsResponseDto.mjs";
+export * from "./MonitorCitation.mjs";
+export * from "./MonitorJobItem.mjs";
+export * from "./MonitorListItemDto.mjs";
+export * from "./MonitorRecord.mjs";
+export * from "./PullJobResponseDto.mjs";
+export * from "./PullMonitorResponseDto.mjs";
+export * from "./Query.mjs";
+export * from "./Record_.mjs";
+export * from "./ReferenceJob.mjs";
+export * from "./Schema.mjs";
+export * from "./StatusResponseDto.mjs";
+export * from "./SubmitResponseBody.mjs";
+export * from "./ValidationErrorDetail.mjs";
+export * from "./ValidationErrorResponse.mjs";
+export * from "./WebhookDto.mjs";
+export * from "./WebhookPayload.mjs";