newscatcher-catchall-sdk 2.0.0 → 3.0.0

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

@@ -0,0 +1,25 @@
+/**
+ * Category of a query issue identified during validation.
+ *
+ * - `missing_event_type`: Query does not specify a type of event to find.
+ * - `too_vague`: Query lacks sufficient focus to return targeted results.
+ * - `too_specific`: Query is overly constrained and may return no results.
+ * - `wrong_timeframe`: Requested timeframe exceeds the 30-day maximum window or references a historical period outside the supported range.
+ * - `static_content`: Query targets static or reference content such as specifications, how-to guides, or historical data rather than events.
+ * - `article_request`: Query requests articles or news content rather than describing an event to search for.
+ * - `multiple_event_types`: Query mixes unrelated event types; results may be unfocused.
+ * - `too_short`: Query is too short to resolve meaningful search intent.
+ * - `too_long`: Query is excessively long and may confuse the pipeline.
+ */
+export declare const IssueType: {
+    readonly MissingEventType: "missing_event_type";
+    readonly TooVague: "too_vague";
+    readonly TooSpecific: "too_specific";
+    readonly WrongTimeframe: "wrong_timeframe";
+    readonly StaticContent: "static_content";
+    readonly ArticleRequest: "article_request";
+    readonly MultipleEventTypes: "multiple_event_types";
+    readonly TooShort: "too_short";
+    readonly TooLong: "too_long";
+};
+export type IssueType = (typeof IssueType)[keyof typeof IssueType];

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

@@ -0,0 +1,25 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * Category of a query issue identified during validation.
+ *
+ * - `missing_event_type`: Query does not specify a type of event to find.
+ * - `too_vague`: Query lacks sufficient focus to return targeted results.
+ * - `too_specific`: Query is overly constrained and may return no results.
+ * - `wrong_timeframe`: Requested timeframe exceeds the 30-day maximum window or references a historical period outside the supported range.
+ * - `static_content`: Query targets static or reference content such as specifications, how-to guides, or historical data rather than events.
+ * - `article_request`: Query requests articles or news content rather than describing an event to search for.
+ * - `multiple_event_types`: Query mixes unrelated event types; results may be unfocused.
+ * - `too_short`: Query is too short to resolve meaningful search intent.
+ * - `too_long`: Query is excessively long and may confuse the pipeline.
+ */
+export const IssueType = {
+    MissingEventType: "missing_event_type",
+    TooVague: "too_vague",
+    TooSpecific: "too_specific",
+    WrongTimeframe: "wrong_timeframe",
+    StaticContent: "static_content",
+    ArticleRequest: "article_request",
+    MultipleEventTypes: "multiple_event_types",
+    TooShort: "too_short",
+    TooLong: "too_long",
+};

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

@@ -3,6 +3,6 @@ export interface JobStep {
     status: CatchAllApi.PublicJobStatus;
     /** Sequential position of this step in the pipeline (1-7). */
     order: number;
-    /** Whether this step has finished processing. */
+    /** True if this step has finished processing; false otherwise. */
     completed: boolean;
 }

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

@@ -0,0 +1,13 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface ListWebhookResourcesResponseDto {
+    /** Total number of resource mappings for this webhook. */
+    total: number;
+    /** Current page number. */
+    page: number;
+    /** Number of mappings per page. */
+    page_size: number;
+    /** Total number of pages available. */
+    total_pages: number;
+    /** Resource mappings on this page. */
+    resources: CatchAllApi.WebhookResourceMappingResponseDto[];
+}

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

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

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

@@ -0,0 +1,13 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface ListWebhooksResponseDto {
+    /** Total number of webhooks in the organization. */
+    total: number;
+    /** Current page number. */
+    page: number;
+    /** Number of webhooks per page. */
+    page_size: number;
+    /** Total number of pages available. */
+    total_pages: number;
+    /** Webhooks on this page. */
+    webhooks: CatchAllApi.WebhookResponseDto[];
+}

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

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

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

@@ -0,0 +1,7 @@
+/** Resource types that can be assigned to a webhook. */
+export declare const MappableResourceType: {
+    readonly Job: "job";
+    readonly Monitor: "monitor";
+    readonly MonitorGroup: "monitor_group";
+};
+export type MappableResourceType = (typeof MappableResourceType)[keyof typeof MappableResourceType];

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

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Resource types that can be assigned to a webhook. */
+export const MappableResourceType = {
+    Job: "job",
+    Monitor: "monitor",
+    MonitorGroup: "monitor_group",
+};

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

@@ -6,7 +6,7 @@ export interface MonitorListItemDto {
     reference_job_id: string;
     /** Plain text query from the reference job. */
     reference_job_query: string;
-    /** Whether the monitor is currently active. */
+    /** True if the monitor is currently active; false otherwise. */
     enabled: boolean;
     /** Cron expression for monitor schedule. */
     schedule?: string | undefined;

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

@@ -1,6 +1,6 @@
 import type * as CatchAllApi from "../index.mjs";
 export interface MonitorStatusHistoryResponseDto {
-    /** Whether the request succeeded. */
+    /** True if the request succeeded; false otherwise. */
     success: boolean;
     /** Optional message. `null` on success. */
     message?: (string | null) | undefined;

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

@@ -0,0 +1,13 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface ProjectListResponseDto {
+    /** Total number of projects matching the filter criteria. */
+    total: number;
+    /** Current page number. */
+    page: number;
+    /** Number of projects per page. */
+    page_size: number;
+    /** Total number of pages. */
+    total_pages: number;
+    /** Projects on this page. */
+    projects: CatchAllApi.ProjectSummaryDto[];
+}

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * Status breakdown for a single resource type.
+ */
+export type ProjectOverviewCountsDto = Record<string, unknown>;

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

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

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

@@ -0,0 +1,18 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface ProjectOverviewResponseDto {
+    /** Project identifier. */
+    project_id: string;
+    /** Resource counts grouped by type. */
+    overview: ProjectOverviewResponseDto.Overview;
+}
+export declare namespace ProjectOverviewResponseDto {
+    /**
+     * Resource counts grouped by type.
+     */
+    interface Overview {
+        jobs: CatchAllApi.ProjectOverviewCountsDto;
+        monitors: CatchAllApi.ProjectOverviewCountsDto;
+        datasets: CatchAllApi.ProjectOverviewCountsDto;
+        monitor_groups: CatchAllApi.ProjectOverviewCountsDto;
+    }
+}

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

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

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

@@ -0,0 +1,18 @@
+import type * as CatchAllApi from "../index.mjs";
+/**
+ * A resource assigned to a project.
+ */
+export interface ProjectResourceDto {
+    resource_type: CatchAllApi.ProjectResourceType;
+    /** Resource identifier. */
+    resource_id: string;
+    /**
+     * Resource display name. For jobs, this is the original query
+     * string. For monitors and datasets, this is the resource name.
+     */
+    name?: string | undefined;
+    /** Resource creation timestamp. */
+    created_at?: string | undefined;
+    /** Additional resource-specific metadata. */
+    metadata?: Record<string, unknown> | undefined;
+}

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

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

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

@@ -0,0 +1,13 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface ProjectResourceListResponseDto {
+    /** Total number of resources assigned to the project. */
+    total: number;
+    /** Current page number. */
+    page: number;
+    /** Number of resources per page. */
+    page_size: number;
+    /** Total number of pages. */
+    total_pages: number;
+    /** Resources on this page. */
+    resources: CatchAllApi.ProjectResourceDto[];
+}

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

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

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

@@ -0,0 +1,8 @@
+/** Resource type for project association. */
+export declare const ProjectResourceType: {
+    readonly Job: "job";
+    readonly Monitor: "monitor";
+    readonly Dataset: "dataset";
+    readonly MonitorGroup: "monitor_group";
+};
+export type ProjectResourceType = (typeof ProjectResourceType)[keyof typeof ProjectResourceType];

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

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Resource type for project association. */
+export const ProjectResourceType = {
+    Job: "job",
+    Monitor: "monitor",
+    Dataset: "dataset",
+    MonitorGroup: "monitor_group",
+};

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

@@ -0,0 +1,18 @@
+export interface ProjectResponseDto {
+    /** True if the operation succeeded; false otherwise. */
+    success: boolean;
+    /** Human-readable result message. */
+    message: string;
+    /** Project identifier. */
+    project_id: string;
+    /** Project name. */
+    name: string;
+    /** Project description. */
+    description?: (string | null) | undefined;
+    /** Number of resources assigned to this project. */
+    resources_count?: number | undefined;
+    /** Project creation timestamp. */
+    created_at?: string | undefined;
+    /** Timestamp of the last update. */
+    updated_at?: string | undefined;
+}

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

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

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

@@ -0,0 +1,17 @@
+/**
+ * Abbreviated project object returned in list responses.
+ */
+export interface ProjectSummaryDto {
+    /** Project identifier. */
+    project_id: string;
+    /** Project name. */
+    name: string;
+    /** Project description. */
+    description?: (string | null) | undefined;
+    /** Number of resources assigned to this project. */
+    resources_count?: number | undefined;
+    /** Project creation timestamp. */
+    created_at?: string | undefined;
+    /** Timestamp of the last update. */
+    updated_at?: string | undefined;
+}

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

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

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

@@ -0,0 +1,13 @@
+/**
+ * Quality level assigned to a query by the validation endpoint.
+ *
+ * - `good`: Query is well-formed and likely to produce relevant results.
+ * - `needs_work`: Query has issues that may reduce result quality. Review `suggestions` for improvements.
+ * - `critical`: Query is unlikely to produce useful results as written. Address all `issues` before submitting.
+ */
+export declare const QueryStatus: {
+    readonly Good: "good";
+    readonly NeedsWork: "needs_work";
+    readonly Critical: "critical";
+};
+export type QueryStatus = (typeof QueryStatus)[keyof typeof QueryStatus];

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

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * Quality level assigned to a query by the validation endpoint.
+ *
+ * - `good`: Query is well-formed and likely to produce relevant results.
+ * - `needs_work`: Query has issues that may reduce result quality. Review `suggestions` for improvements.
+ * - `critical`: Query is unlikely to produce useful results as written. Address all `issues` before submitting.
+ */
+export const QueryStatus = {
+    Good: "good",
+    NeedsWork: "needs_work",
+    Critical: "critical",
+};

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

@@ -0,0 +1,6 @@
+export interface RemoveResourceResponseDto {
+    /** True if the operation succeeded; false otherwise. */
+    success: boolean;
+    /** Human-readable result message. */
+    message: string;
+}

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

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

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

@@ -0,0 +1,6 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface ResourceItemDto {
+    resource_type: CatchAllApi.ProjectResourceType;
+    /** ID of the resource to add. */
+    resource_id: string;
+}

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

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

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

@@ -0,0 +1,12 @@
+export interface ResourceResultDto {
+    /** Type of the resource. */
+    resource_type: string;
+    /** Resource identifier. */
+    resource_id: string;
+    /** True if this resource was processed successfully. */
+    success: boolean;
+    /** Per-resource result message. */
+    message: string;
+    /** True if the resource is already assigned to this project. */
+    already_exists?: boolean | undefined;
+}

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

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

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

@@ -0,0 +1,12 @@
+import type * as CatchAllApi from "../index.mjs";
+/**
+ * Actionable recommendation for improving a query.
+ */
+export interface Suggestion {
+    /** The issue this suggestion addresses. */
+    issue: CatchAllApi.IssueType;
+    /** Specific guidance for improving the query. */
+    message: string;
+    /** Revised query demonstrating the suggested improvement. */
+    example?: string | undefined;
+}

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

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

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

@@ -0,0 +1,10 @@
+export interface TestWebhookResponseDto {
+    /** True if the test delivery received a 2xx response; false otherwise. */
+    success: boolean;
+    /** Human-readable result message. */
+    message: string;
+    /** HTTP status code returned by the webhook endpoint. */
+    http_status_code?: number | undefined;
+    /** Response body returned by the webhook endpoint. Type varies by target. */
+    response_body?: unknown | undefined;
+}

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

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

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

@@ -0,0 +1,8 @@
+export interface UpdateProjectResponseDto {
+    /** True if the operation succeeded; false otherwise. */
+    success: boolean;
+    /** Human-readable result message. */
+    message: string;
+    /** Project identifier. */
+    project_id: string;
+}

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

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

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

@@ -0,0 +1,9 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface UpdateWebhookResponseDto {
+    /** True if the webhook was updated; false otherwise. */
+    success: boolean;
+    /** Human-readable result message. */
+    message: string;
+    /** The updated webhook object. */
+    webhook?: CatchAllApi.WebhookResponseDto | undefined;
+}

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

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

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

@@ -0,0 +1,18 @@
+import type * as CatchAllApi from "../index.mjs";
+/**
+ * Query quality assessment returned by the validate endpoint.
+ */
+export interface ValidateQueryResponseDto {
+    /** Overall quality level of the query. */
+    status: CatchAllApi.QueryStatus;
+    /** Short headline summarising the assessment. */
+    title: string;
+    /** Plain-language explanation of the assessment result. */
+    description?: string | undefined;
+    /** Issues identified in the query. Empty when `status` is `good`. */
+    issues?: CatchAllApi.IssueType[] | undefined;
+    /** Actionable recommendations for each identified issue. Empty when `status` is `good`. Each suggestion corresponds to one entry in `issues`. */
+    suggestions?: CatchAllApi.Suggestion[] | undefined;
+    /** Confidence score for this assessment. */
+    confidence: number;
+}

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

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

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

@@ -0,0 +1,12 @@
+export interface WebhookResourceMappingResponseDto {
+    /** Mapping identifier. */
+    id: string;
+    /** Webhook identifier. */
+    webhook_id: string;
+    /** Type of the assigned resource. */
+    resource_type: string;
+    /** Identifier of the assigned resource. */
+    resource_id: string;
+    /** Timestamp when the resource was assigned in ISO 8601 format with UTC timezone. */
+    assigned_at?: string | undefined;
+}

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

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

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

@@ -0,0 +1,28 @@
+import type * as CatchAllApi from "../index.mjs";
+export interface WebhookResponseDto {
+    /** Webhook identifier. */
+    id: string;
+    /** Human-readable label for this webhook. */
+    name: string;
+    /** Destination URL that receives the payload. */
+    url: string;
+    type: CatchAllApi.WebhookType;
+    delivery_mode: CatchAllApi.DeliveryMode;
+    method: CatchAllApi.HttpMethod;
+    /** Custom HTTP headers forwarded with each delivery. */
+    headers?: Record<string, string> | undefined;
+    /** Query parameters appended to the webhook URL. */
+    params?: Record<string, string> | undefined;
+    /** Custom payload transformation configuration. Used only when `type` is `custom`. */
+    formatter_config?: (Record<string, unknown> | null) | undefined;
+    /** True if the webhook is active; false otherwise. */
+    is_active: boolean;
+    /** Organization that owns this webhook. */
+    organization_id?: string | undefined;
+    /** ID of the user who created this webhook. */
+    created_by_user_id?: string | undefined;
+    /** Webhook creation timestamp in ISO 8601 format with UTC timezone. */
+    created_at?: string | undefined;
+    /** Timestamp of the last update in ISO 8601 format with UTC timezone. */
+    updated_at?: string | undefined;
+}

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

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

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

@@ -0,0 +1,17 @@
+/**
+ * Webhook target type.
+ *
+ * - `generic`: Sends the raw result payload to any HTTPS endpoint.
+ * - `slack`: Sends a formatted Slack Block Kit message. URL must start with `https://hooks.slack.com/`.
+ * - `teams`: Sends a formatted Microsoft Teams Adaptive Card. URL hostname must match `*webhook.office.com` or `*.webhook.office365.com`.
+ * - `custom`: Sends a transformed payload using the configuration in `formatter_config`. Requires `formatter_config` to be set.
+ *
+ * When `type` is omitted, it is auto-detected from the URL.
+ */
+export declare const WebhookType: {
+    readonly Generic: "generic";
+    readonly Slack: "slack";
+    readonly Teams: "teams";
+    readonly Custom: "custom";
+};
+export type WebhookType = (typeof WebhookType)[keyof typeof WebhookType];

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

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * Webhook target type.
+ *
+ * - `generic`: Sends the raw result payload to any HTTPS endpoint.
+ * - `slack`: Sends a formatted Slack Block Kit message. URL must start with `https://hooks.slack.com/`.
+ * - `teams`: Sends a formatted Microsoft Teams Adaptive Card. URL hostname must match `*webhook.office.com` or `*.webhook.office365.com`.
+ * - `custom`: Sends a transformed payload using the configuration in `formatter_config`. Requires `formatter_config` to be set.
+ *
+ * When `type` is omitted, it is auto-detected from the URL.
+ */
+export const WebhookType = {
+    Generic: "generic",
+    Slack: "slack",
+    Teams: "teams",
+    Custom: "custom",
+};