newscatcher-catchall-sdk 1.0.0 → 1.3.1

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

@@ -23,9 +23,7 @@ export class JobsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
-     * Get suggested validators, enrichments, and date ranges for a query before submitting a job.
-     *
-     * Returns LLM-generated suggestions based on query analysis and validates against plan limits.
+     * Get suggested validators, enrichments, and date ranges for a query.
      *
      * @param {CatchAllApi.InitializeRequestDto} request
      * @param {JobsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -35,7 +33,8 @@ export class JobsClient {
      *
      * @example
      *     await client.jobs.initialize({
-     *         query: "AI company acquisitions in fintech last week"
+     *         query: "Series B funding rounds for SaaS startups",
+     *         context: "Focus on funding amount and company name"
      *     })
      */
     initialize(request, requestOptions) {
@@ -81,10 +80,7 @@ export class JobsClient {
         });
     }
     /**
-     * Submit a natural language query to create a new processing job.
-     *
-     * Optionally specify context, date ranges, limit, custom validators, and enrichments.
-     * If dates exceed plan limits, returns 400 error.
+     * Submit a query to create a new processing job.
      *
      * @param {CatchAllApi.SubmitRequestDto} request
      * @param {JobsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -95,11 +91,12 @@ export class JobsClient {
      *
      * @example
      *     await client.jobs.createJob({
-     *         query: "AI company acquisitions",
-     *         context: "Focus on deal size and acquiring company details",
+     *         query: "Series B funding rounds for SaaS startups",
+     *         context: "Focus on funding amount and company name",
      *         limit: 10,
-     *         start_date: "2026-01-30T00:00:00Z",
-     *         end_date: "2026-02-05T00:00:00Z"
+     *         start_date: "2026-02-18T00:00:00Z",
+     *         end_date: "2026-02-23T00:00:00Z",
+     *         mode: "base"
      *     })
      */
     createJob(request, requestOptions) {
@@ -158,7 +155,7 @@ export class JobsClient {
      *
      * @example
      *     await client.jobs.continueJob({
-     *         job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3",
+     *         job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
      *         new_limit: 100
      *     })
      */
@@ -217,7 +214,7 @@ export class JobsClient {
      *
      * @example
      *     await client.jobs.getJobStatus({
-     *         job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
+     *         job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
      *     })
      */
     getJobStatus(request, requestOptions) {
@@ -296,10 +293,7 @@ export class JobsClient {
                 logging: this._options.logging,
             });
             if (_response.ok) {
-                return {
-                    data: _response.body,
-                    rawResponse: _response.rawResponse,
-                };
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -327,7 +321,7 @@ export class JobsClient {
      *
      * @example
      *     await client.jobs.getJobResults({
-     *         job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
+     *         job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
      *     })
      */
     getJobResults(request, requestOptions) {

package/dist/esm/api/resources/jobs/client/requests/ContinueRequestDto.d.mts

@@ -1,13 +1,13 @@
 /**
  * @example
  *     {
- *         job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3",
+ *         job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
  *         new_limit: 100
  *     }
  */
 export interface ContinueRequestDto {
     /** Job identifier of the completed job to continue. */
     job_id: string;
-    /** New record limit for continued processing. Must be greater than the previous limit. */
-    new_limit: number;
+    /** New record limit for continued processing. Must be greater than the previous limit. If not provided, defaults to the plan maximum. */
+    new_limit?: number;
 }

package/dist/esm/api/resources/jobs/client/requests/GetJobResultsRequest.d.mts

@@ -1,11 +1,11 @@
 /**
  * @example
  *     {
- *         job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
+ *         job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
  *     }
  */
 export interface GetJobResultsRequest {
-    /** Unique job identifier returned from the [`POST /catchAll/submit`](https://www.newscatcherapi.com/docs/v3/catch-all/endpoints/create-job) endpoint. */
+    /** Unique job identifier returned from [`POST /catchAll/submit`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/create-job). */
     job_id: string;
     /** Page number to retrieve. */
     page?: number;

package/dist/esm/api/resources/jobs/client/requests/GetJobStatusRequest.d.mts

@@ -1,10 +1,10 @@
 /**
  * @example
  *     {
- *         job_id: "af7a26d6-cf0b-458c-a6ed-4b6318c74da3"
+ *         job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c"
  *     }
  */
 export interface GetJobStatusRequest {
-    /** Unique job identifier returned from the [`POST /catchAll/submit`](https://www.newscatcherapi.com/docs/v3/catch-all/endpoints/create-job) endpoint. */
+    /** Unique job identifier returned from [`POST /catchAll/submit`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/create-job). */
     job_id: string;
 }

package/dist/esm/api/resources/jobs/client/requests/InitializeRequestDto.d.mts

@@ -2,7 +2,8 @@ import type * as CatchAllApi from "../../../../index.mjs";
 /**
  * @example
  *     {
- *         query: "AI company acquisitions in fintech last week"
+ *         query: "Series B funding rounds for SaaS startups",
+ *         context: "Focus on funding amount and company name"
  *     }
  */
 export interface InitializeRequestDto {

package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.d.mts

@@ -2,22 +2,22 @@ import type * as CatchAllApi from "../../../../index.mjs";
 /**
  * @example
  *     {
- *         query: "AI company acquisitions",
- *         context: "Focus on deal size and acquiring company details",
+ *         query: "Series B funding rounds for SaaS startups",
+ *         context: "Focus on funding amount and company name",
  *         limit: 10,
- *         start_date: "2026-01-30T00:00:00Z",
- *         end_date: "2026-02-05T00:00:00Z"
+ *         start_date: "2026-02-18T00:00:00Z",
+ *         end_date: "2026-02-23T00:00:00Z",
+ *         mode: "base"
  *     }
  */
 export interface SubmitRequestDto {
     query: CatchAllApi.Query;
-    schema?: CatchAllApi.Schema;
     context?: CatchAllApi.Context;
     limit?: CatchAllApi.Limit;
     start_date?: CatchAllApi.StartDate;
     end_date?: CatchAllApi.EndDate;
     /**
-     * Custom validators for filtering article clusters.
+     * Custom validators for filtering web page clusters.
      *
      * If not provided, validators are generated automatically based on the query.
      */
@@ -28,4 +28,24 @@ export interface SubmitRequestDto {
      * If not provided, enrichments are generated automatically based on the query.
      */
     enrichments?: CatchAllApi.EnrichmentSchema[];
+    /**
+     * Job processing mode.
+     *
+     * - `base`: Full pipeline with validation and enrichment.
+     * - `lite`: Lightweight extraction with faster processing. Returns titles and citations only.
+     */
+    mode?: SubmitRequestDto.Mode;
+}
+export declare namespace SubmitRequestDto {
+    /**
+     * Job processing mode.
+     *
+     * - `base`: Full pipeline with validation and enrichment.
+     * - `lite`: Lightweight extraction with faster processing. Returns titles and citations only.
+     */
+    const Mode: {
+        readonly Lite: "lite";
+        readonly Base: "base";
+    };
+    type Mode = (typeof Mode)[keyof typeof Mode];
 }

package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.mjs

@@ -1,2 +1,14 @@
 // This file was auto-generated by Fern from our API Definition.
-export {};
+export var SubmitRequestDto;
+(function (SubmitRequestDto) {
+    /**
+     * Job processing mode.
+     *
+     * - `base`: Full pipeline with validation and enrichment.
+     * - `lite`: Lightweight extraction with faster processing. Returns titles and citations only.
+     */
+    SubmitRequestDto.Mode = {
+        Lite: "lite",
+        Base: "base",
+    };
+})(SubmitRequestDto || (SubmitRequestDto = {}));

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

@@ -3,4 +3,4 @@ export type { GetJobResultsRequest } from "./GetJobResultsRequest.mjs";
 export type { GetJobStatusRequest } from "./GetJobStatusRequest.mjs";
 export type { GetUserJobsRequest } from "./GetUserJobsRequest.mjs";
 export type { InitializeRequestDto } from "./InitializeRequestDto.mjs";
-export type { SubmitRequestDto } from "./SubmitRequestDto.mjs";
+export { SubmitRequestDto } from "./SubmitRequestDto.mjs";

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

@@ -1 +1 @@
-export {};
+export { SubmitRequestDto } from "./SubmitRequestDto.mjs";

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

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

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

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

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

@@ -1,7 +1,7 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
-import { type NormalizedClientOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import * as core from "../../../../core/index.mjs";
-import type * as CatchAllApi from "../../../index.mjs";
+import * as CatchAllApi from "../../../index.mjs";
 export declare namespace MetaClient {
     type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
@@ -11,7 +11,7 @@ export declare namespace MetaClient {
  * Operations to check API health and version.
  */
 export declare class MetaClient {
-    protected readonly _options: NormalizedClientOptions<MetaClient.Options>;
+    protected readonly _options: NormalizedClientOptionsWithAuth<MetaClient.Options>;
     constructor(options?: MetaClient.Options);
     /**
      * Check API availability.
@@ -33,4 +33,16 @@ export declare class MetaClient {
      */
     getVersion(requestOptions?: MetaClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.GetVersionResponse>;
     private __getVersion;
+    /**
+     * Returns plan features and current usage for the authenticated organization.
+     *
+     * @param {MetaClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     *
+     * @example
+     *     await client.meta.getPlanLimits()
+     */
+    getPlanLimits(requestOptions?: MetaClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.GetPlanLimitsResponseDto>;
+    private __getPlanLimits;
 }

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

@@ -8,18 +8,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { normalizeClientOptions } from "../../../../BaseClient.mjs";
+import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import { mergeHeaders } from "../../../../core/headers.mjs";
 import * as core from "../../../../core/index.mjs";
 import * as environments from "../../../../environments.mjs";
 import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
 import * as errors from "../../../../errors/index.mjs";
+import * as CatchAllApi from "../../../index.mjs";
 /**
  * Operations to check API health and version.
  */
 export class MetaClient {
     constructor(options = {}) {
-        this._options = normalizeClientOptions(options);
+        this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
      * Check API availability.
@@ -99,4 +100,51 @@ export class MetaClient {
             return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/version");
         });
     }
+    /**
+     * Returns plan features and current usage for the authenticated organization.
+     *
+     * @param {MetaClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     *
+     * @example
+     *     await client.meta.getPlanLimits()
+     */
+    getPlanLimits(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getPlanLimits(requestOptions));
+    }
+    __getPlanLimits(requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, "catchAll/user/limits"),
+                method: "POST",
+                headers: _headers,
+                queryParameters: 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,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 403:
+                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CatchAllApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/catchAll/user/limits");
+        });
+    }
 }

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

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

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

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

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

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

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

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

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

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