newscatcher-catchall-sdk 1.5.1 → 3.0.0

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

@@ -23,7 +23,9 @@ export declare class MonitorsClient {
      * @throws {@link CatchAllApi.UnprocessableEntityError}
      *
      * @example
-     *     await client.monitors.listMonitors()
+     *     await client.monitors.listMonitors({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
+     *     })
      */
     listMonitors(request?: CatchAllApi.ListMonitorsRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListMonitorsResponseDto>;
     private __listMonitors;
@@ -38,14 +40,9 @@ export declare class MonitorsClient {
      * @example
      *     await client.monitors.createMonitor({
      *         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"
-     *             }
-     *         },
+     *         schedule: "every day at 12 PM",
+     *         timezone: "UTC",
+     *         webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"],
      *         limit: 10,
      *         backfill: true
      *     })
@@ -171,13 +168,7 @@ export declare class MonitorsClient {
      * @example
      *     await client.monitors.updateMonitor({
      *         monitor_id: "monitor_id",
-     *         webhook: {
-     *             url: "https://new-endpoint.com/webhook",
-     *             method: "POST",
-     *             headers: {
-     *                 "Authorization": "Bearer new_token_xyz"
-     *             }
-     *         }
+     *         webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
      *     })
      */
     updateMonitor(request: CatchAllApi.UpdateMonitorRequestDto, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.UpdateMonitorResponseDto>;

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

@@ -43,7 +43,9 @@ export class MonitorsClient {
      * @throws {@link CatchAllApi.UnprocessableEntityError}
      *
      * @example
-     *     await client.monitors.listMonitors()
+     *     await client.monitors.listMonitors({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
+     *     })
      */
     listMonitors(request = {}, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__listMonitors(request, requestOptions));
@@ -51,12 +53,13 @@ export class MonitorsClient {
     __listMonitors() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { page, page_size: pageSize, search, ownership } = request;
+            const { page, page_size: pageSize, search, ownership, project_id: projectId } = request;
             const _queryParams = {
                 page,
                 page_size: pageSize,
                 search,
                 ownership: ownership != null ? ownership : undefined,
+                project_id: projectId,
             };
             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);
@@ -106,14 +109,9 @@ export class MonitorsClient {
      * @example
      *     await client.monitors.createMonitor({
      *         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"
-     *             }
-     *         },
+     *         schedule: "every day at 12 PM",
+     *         timezone: "UTC",
+     *         webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"],
      *         limit: 10,
      *         backfill: true
      *     })
@@ -522,13 +520,7 @@ export class MonitorsClient {
      * @example
      *     await client.monitors.updateMonitor({
      *         monitor_id: "monitor_id",
-     *         webhook: {
-     *             url: "https://new-endpoint.com/webhook",
-     *             method: "POST",
-     *             headers: {
-     *                 "Authorization": "Bearer new_token_xyz"
-     *             }
-     *         }
+     *         webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
      *     })
      */
     updateMonitor(request, requestOptions) {

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

@@ -1,16 +1,10 @@
-import type * as CatchAllApi from "../../../../index.mjs";
 /**
  * @example
  *     {
  *         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"
- *             }
- *         },
+ *         schedule: "every day at 12 PM",
+ *         timezone: "UTC",
+ *         webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"],
  *         limit: 10,
  *         backfill: true
  *     }
@@ -22,14 +16,21 @@ export interface CreateMonitorRequestDto {
      * 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;
+    /** Monitor schedule in plain text format. Minimum frequency depends on your plan. */
+    schedule: string;
     /**
-     * Monitor schedule in plain text format (e.g. 'every day at 12 PM UTC', 'every 48 hours').
+     * The IANA timezone identifier used as the fallback when the `schedule` string does not include an explicit timezone.
      *
-     * Minimum frequency depends on your plan.
+     * If the schedule includes a timezone abbreviation (for example, `"every day at 9am EST"`), the parsed timezone takes priority and this value is ignored.
      */
-    schedule: string;
-    /** Optional webhook to receive notifications when jobs complete. */
-    webhook?: CatchAllApi.WebhookDto;
+    timezone?: string;
+    /**
+     * IDs of centralized webhooks to notify on each run completion.
+     * Passing IDs here is equivalent to calling
+     * `POST /catchAll/webhooks/{webhook_id}/resources` for each ID after creation.
+     * Maximum 5 per monitor.
+     */
+    webhook_ids?: string[];
     /** Maximum number of records per monitor run. If not provided, defaults to the plan limit. */
     limit?: number;
     /**
@@ -38,4 +39,6 @@ export interface CreateMonitorRequestDto {
      * 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;
+    /** Project to assign this monitor to. The monitor appears in the project's resource list after creation. */
+    project_id?: string;
 }

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

@@ -1,7 +1,9 @@
 import type * as CatchAllApi from "../../../../index.mjs";
 /**
  * @example
- *     {}
+ *     {
+ *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
+ *     }
  */
 export interface ListMonitorsRequest {
     /** Page number to retrieve. */
@@ -10,6 +12,7 @@ export interface ListMonitorsRequest {
     page_size?: number;
     /** Filter results by text (case-insensitive substring match). */
     search?: string;
-    /** Filter results by ownership. Defaults to `all`. */
     ownership?: CatchAllApi.OwnershipFilter;
+    /** Filter results to resources belonging to this project. */
+    project_id?: string;
 }

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

@@ -1,22 +1,19 @@
-import type * as CatchAllApi from "../../../../index.mjs";
 /**
  * @example
  *     {
  *         monitor_id: "monitor_id",
- *         webhook: {
- *             url: "https://new-endpoint.com/webhook",
- *             method: "POST",
- *             headers: {
- *                 "Authorization": "Bearer new_token_xyz"
- *             }
- *         }
+ *         webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
  *     }
  */
 export interface UpdateMonitorRequestDto {
     /** Monitor identifier. */
     monitor_id: string;
-    /** Updated webhook configuration. */
-    webhook?: CatchAllApi.WebhookDto;
+    /**
+     * Updated list of centralized webhook IDs for this monitor.
+     *
+     * Replaces all existing webhook assignments. Pass an empty array `[]` to clear all assignments. Omit to leave existing assignments unchanged.
+     */
+    webhook_ids?: string[];
     /** Updated maximum number of records per monitor run. */
     limit?: number;
 }

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

@@ -1,5 +1,5 @@
 export interface DisableMonitorResponse {
-    /** Whether the operation succeeded. */
+    /** True if the operation succeeded; false otherwise. */
     success: boolean;
     /** Human-readable success message. */
     message: string;

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

@@ -1,5 +1,5 @@
 export interface EnableMonitorResponse {
-    /** Whether the operation succeeded. */
+    /** True if the operation succeeded; false otherwise. */
     success: boolean;
     /** Human-readable success message. */
     message: string;

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

@@ -0,0 +1,178 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as CatchAllApi from "../../../index.mjs";
+export declare namespace ProjectsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Operations to create, organize, and manage projects.
+ *
+ * A project is a named container for jobs, monitors, and datasets. Group
+ * related resources by use case, team, or client, and share them with
+ * teammates. Resources can be assigned at creation time or post-hoc.
+ */
+export declare class ProjectsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<ProjectsClient.Options>;
+    constructor(options?: ProjectsClient.Options);
+    /**
+     * Returns all projects visible to the authenticated user.
+     *
+     * @param {CatchAllApi.ListProjectsRequest} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.projects.listProjects({
+     *         search: "M&A"
+     *     })
+     */
+    listProjects(request?: CatchAllApi.ListProjectsRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ProjectListResponseDto>;
+    private __listProjects;
+    /**
+     * Creates a new project.
+     *
+     * @param {CatchAllApi.CreateProjectRequestDto} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.projects.createProject({
+     *         name: "AI M&A Tracking",
+     *         description: "Tracks AI-related M&A activity for our investment team."
+     *     })
+     */
+    createProject(request: CatchAllApi.CreateProjectRequestDto, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.CreateProjectResponseDto>;
+    private __createProject;
+    /**
+     * Returns a single project by ID.
+     *
+     * @param {CatchAllApi.GetProjectRequest} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.projects.getProject({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
+     *     })
+     */
+    getProject(request: CatchAllApi.GetProjectRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ProjectResponseDto>;
+    private __getProject;
+    /**
+     * Deletes a project. By default, assigned resources are unassigned but not deleted.
+     *
+     * @param {CatchAllApi.DeleteProjectRequest} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.projects.deleteProject({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
+     *     })
+     */
+    deleteProject(request: CatchAllApi.DeleteProjectRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteProject;
+    /**
+     * Updates the name or description of an existing project.
+     *
+     * @param {CatchAllApi.UpdateProjectRequestDto} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.projects.updateProject({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
+     *         name: "AI M&A Tracking (Q2 2026)"
+     *     })
+     */
+    updateProject(request: CatchAllApi.UpdateProjectRequestDto, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.UpdateProjectResponseDto>;
+    private __updateProject;
+    /**
+     * Returns resource counts for a project, grouped by type and status.
+     *
+     * For `jobs` and `monitors`, counts are broken down by status (for example, `completed`, `failed`). For `datasets` and `monitor_groups`, only a `total` count is returned.
+     *
+     * @param {CatchAllApi.GetProjectOverviewRequest} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.projects.getProjectOverview({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
+     *     })
+     */
+    getProjectOverview(request: CatchAllApi.GetProjectOverviewRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ProjectOverviewResponseDto>;
+    private __getProjectOverview;
+    /**
+     * Returns all resources assigned to a project, with optional filtering by type.
+     *
+     * @param {CatchAllApi.ListProjectResourcesRequest} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.projects.listProjectResources({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
+     *     })
+     */
+    listProjectResources(request: CatchAllApi.ListProjectResourcesRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ProjectResourceListResponseDto>;
+    private __listProjectResources;
+    /**
+     * Assigns one or more existing resources to a project in a single request.
+     *
+     * @param {CatchAllApi.AddResourceRequestDto} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.BadRequestError}
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.projects.addResourceToProject({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
+     *         resources: [{
+     *                 resource_type: "job",
+     *                 resource_id: "48421e16-1f50-4048-b62c-d3bc0789d30d"
+     *             }]
+     *     })
+     */
+    addResourceToProject(request: CatchAllApi.AddResourceRequestDto, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.AddResourceResponseDto>;
+    private __addResourceToProject;
+    /**
+     * Removes a resource from a project. The resource itself is not
+     * deleted — it becomes unassigned and continues to exist.
+     *
+     * @param {CatchAllApi.RemoveResourceFromProjectRequest} request
+     * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.projects.removeResourceFromProject({
+     *         project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
+     *         resource_type: "job",
+     *         resource_id: "48421e16-1f50-4048-b62c-d3bc0789d30d"
+     *     })
+     */
+    removeResourceFromProject(request: CatchAllApi.RemoveResourceFromProjectRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.RemoveResourceResponseDto>;
+    private __removeResourceFromProject;
+}