newscatcher-catchall-sdk 3.0.1 → 4.0.1

package/dist/cjs/api/resources/monitors/client/Client.js

@@ -58,6 +58,7 @@ exports.MonitorsClient = void 0;
 const BaseClient_js_1 = require("../../../../BaseClient.js");
 const headers_js_1 = require("../../../../core/headers.js");
 const core = __importStar(require("../../../../core/index.js"));
+const requestBody_js_1 = require("../../../../core/requestBody.js");
 const environments = __importStar(require("../../../../environments.js"));
 const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatusCodeError.js");
 const errors = __importStar(require("../../../../errors/index.js"));
@@ -167,7 +168,7 @@ class MonitorsClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: request,
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(request, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
                 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,
@@ -246,6 +247,61 @@ class MonitorsClient {
             return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/catchAll/monitors/pull/{monitor_id}");
         });
     }
+    /**
+     * Returns the most recent run's records as a CSV download. One row per record, with enrichment fields as columns, citations as a JSON column, and connected entities split into `event_associated_entities` and `mention_entities` JSON columns.
+     *
+     * @param {CatchAllApi.PullMonitorResultsCsvRequest} request
+     * @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     *
+     * @example
+     *     await client.monitors.pullMonitorResultsCsv({
+     *         monitor_id: "monitor_id"
+     *     })
+     */
+    pullMonitorResultsCsv(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pullMonitorResultsCsv(request, requestOptions));
+    }
+    __pullMonitorResultsCsv(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { monitor_id: monitorId } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.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/monitors/pull/${core.url.encodePathParam(monitorId)}/csv`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                responseType: "text",
+                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);
+                    case 404:
+                        throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CatchAllApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/catchAll/monitors/pull/{monitor_id}/csv");
+        });
+    }
     /**
      * Return all jobs executed by a monitor.
      *
@@ -396,7 +452,7 @@ class MonitorsClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: _body,
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
                 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,
@@ -575,7 +631,7 @@ class MonitorsClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: _body,
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
                 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,

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

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         monitor_id: "monitor_id"
+ *     }
+ */
+export interface PullMonitorResultsCsvRequest {
+    /** Monitor identifier. */
+    monitor_id: string;
+}

package/dist/cjs/api/resources/monitors/client/requests/PullMonitorResultsCsvRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -5,5 +5,6 @@ export type { EnableMonitorRequestDto } from "./EnableMonitorRequestDto.js";
 export type { GetMonitorStatusHistoryRequest } from "./GetMonitorStatusHistoryRequest.js";
 export type { ListMonitorJobsRequest } from "./ListMonitorJobsRequest.js";
 export type { ListMonitorsRequest } from "./ListMonitorsRequest.js";
+export type { PullMonitorResultsCsvRequest } from "./PullMonitorResultsCsvRequest.js";
 export type { PullMonitorResultsRequest } from "./PullMonitorResultsRequest.js";
 export type { UpdateMonitorRequestDto } from "./UpdateMonitorRequestDto.js";

package/dist/cjs/api/resources/projects/client/Client.js

@@ -58,6 +58,7 @@ exports.ProjectsClient = void 0;
 const BaseClient_js_1 = require("../../../../BaseClient.js");
 const headers_js_1 = require("../../../../core/headers.js");
 const core = __importStar(require("../../../../core/index.js"));
+const requestBody_js_1 = require("../../../../core/requestBody.js");
 const environments = __importStar(require("../../../../environments.js"));
 const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatusCodeError.js");
 const errors = __importStar(require("../../../../errors/index.js"));
@@ -167,7 +168,7 @@ class ProjectsClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: request,
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(request, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
                 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,
@@ -341,7 +342,7 @@ class ProjectsClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: _body,
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
                 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,
@@ -533,7 +534,7 @@ class ProjectsClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: _body,
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
                 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,

package/dist/cjs/api/resources/webhooks/client/Client.d.ts

@@ -208,6 +208,31 @@ export declare class WebhooksClient {
      */
     listWebhooksForResource(request: CatchAllApi.ListWebhooksForResourceRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListWebhooksResponseDto>;
     private __listWebhooksForResource;
+    /**
+     * Manually dispatches a webhook delivery for a resource on demand, without
+     * waiting for the next job or monitor cycle.
+     *
+     * Use this to re-deliver results after a failed delivery, replay a specific
+     * job's results, or validate a webhook against live data. The webhook must
+     * already be assigned to the resource.
+     *
+     * @param {CatchAllApi.TriggerWebhookRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.webhooks.triggerWebhook({
+     *         resource_type: "job",
+     *         resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4",
+     *         webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+     *         job_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
+     *     })
+     */
+    triggerWebhook(request: CatchAllApi.TriggerWebhookRequest, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __triggerWebhook;
     /**
      * Returns a paginated delivery log for a given resource, ordered by timestamp descending.
      *

package/dist/cjs/api/resources/webhooks/client/Client.js

@@ -58,6 +58,7 @@ exports.WebhooksClient = void 0;
 const BaseClient_js_1 = require("../../../../BaseClient.js");
 const headers_js_1 = require("../../../../core/headers.js");
 const core = __importStar(require("../../../../core/index.js"));
+const requestBody_js_1 = require("../../../../core/requestBody.js");
 const environments = __importStar(require("../../../../environments.js"));
 const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatusCodeError.js");
 const errors = __importStar(require("../../../../errors/index.js"));
@@ -168,7 +169,7 @@ class WebhooksClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: request,
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(request, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
                 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,
@@ -341,7 +342,7 @@ class WebhooksClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: _body,
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
                 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,
@@ -407,7 +408,7 @@ class WebhooksClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: _body,
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
                 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,
@@ -543,7 +544,7 @@ class WebhooksClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: _body,
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
                 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,
@@ -702,6 +703,79 @@ class WebhooksClient {
             return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/catchAll/resources/{resource_type}/{resource_id}/webhooks");
         });
     }
+    /**
+     * Manually dispatches a webhook delivery for a resource on demand, without
+     * waiting for the next job or monitor cycle.
+     *
+     * Use this to re-deliver results after a failed delivery, replay a specific
+     * job's results, or validate a webhook against live data. The webhook must
+     * already be assigned to the resource.
+     *
+     * @param {CatchAllApi.TriggerWebhookRequest} request
+     * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CatchAllApi.ForbiddenError}
+     * @throws {@link CatchAllApi.NotFoundError}
+     * @throws {@link CatchAllApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.webhooks.triggerWebhook({
+     *         resource_type: "job",
+     *         resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4",
+     *         webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+     *         job_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
+     *     })
+     */
+    triggerWebhook(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__triggerWebhook(request, requestOptions));
+    }
+    __triggerWebhook(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { resource_type: resourceType, resource_id: resourceId, webhook_id: webhookId, job_id: jobId } = request;
+            const _queryParams = {
+                webhook_id: webhookId,
+                job_id: jobId,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.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/webhook/trigger/${core.url.encodePathParam(resourceType)}/${core.url.encodePathParam(resourceId)}`),
+                method: "POST",
+                headers: _headers,
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
+                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: undefined, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 403:
+                        throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new CatchAllApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CatchAllApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/catchAll/webhook/trigger/{resource_type}/{resource_id}");
+        });
+    }
     /**
      * Returns a paginated delivery log for a given resource, ordered by timestamp descending.
      *

package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequestDto.d.ts

@@ -37,6 +37,6 @@ export interface CreateWebhookRequestDto {
      * - `basic`: Adds an `Authorization: Basic <credentials>` header.
      */
     auth?: CatchAllApi.CreateWebhookRequestDtoAuth;
-    /** Custom payload transformation configuration. Required only when `type` is `custom`. */
-    formatter_config?: Record<string, unknown> | null;
+    /** Custom payload formatter. Required when `type` is `custom`. */
+    formatter_config?: CatchAllApi.FormatterConfigDto | null;
 }

package/dist/cjs/api/resources/webhooks/client/requests/TriggerWebhookRequest.d.ts

@@ -0,0 +1,23 @@
+import type * as CatchAllApi from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         resource_type: "job",
+ *         resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4",
+ *         webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+ *         job_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
+ *     }
+ */
+export interface TriggerWebhookRequest {
+    resource_type: CatchAllApi.MappableResourceType;
+    /** Unique resource identifier. */
+    resource_id: string;
+    /** Identifier of the webhook to trigger. Must be assigned to the resource. */
+    webhook_id: string;
+    /**
+     * Specific job run to deliver. Optional for `job` resources; for
+     * `monitor` and `monitor_group` resources, selects a past run to replay.
+     * When omitted, the latest available results are delivered.
+     */
+    job_id?: string;
+}

package/dist/cjs/api/resources/webhooks/client/requests/TriggerWebhookRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequestDto.d.ts

@@ -23,8 +23,8 @@ export interface UpdateWebhookRequestDto {
     params?: Record<string, string>;
     /** Updated authentication configuration. Replaces existing auth entirely. */
     auth?: CatchAllApi.UpdateWebhookRequestDtoAuth;
-    /** Updated formatter configuration. */
-    formatter_config?: Record<string, unknown> | null;
+    /** Updated custom payload formatter. Set only when `type` is `custom`. */
+    formatter_config?: CatchAllApi.FormatterConfigDto | null;
     /** Set to `false` to disable delivery without deleting the webhook. */
     is_active?: boolean;
 }

package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts

@@ -8,4 +8,5 @@ export type { ListWebhooksForResourceRequest } from "./ListWebhooksForResourceRe
 export type { ListWebhooksRequest } from "./ListWebhooksRequest.js";
 export type { RemoveWebhookResourceRequest } from "./RemoveWebhookResourceRequest.js";
 export type { TestWebhookRequestDto } from "./TestWebhookRequestDto.js";
+export type { TriggerWebhookRequest } from "./TriggerWebhookRequest.js";
 export type { UpdateWebhookRequestDto } from "./UpdateWebhookRequestDto.js";

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

@@ -8,8 +8,6 @@ export interface CompanyAttributes {
      * The most reliable identifier — strongly recommended when available.
      */
     domain?: (string | null) | undefined;
-    /** Detailed description of the company used for matching. */
-    description?: (string | null) | undefined;
     /** Names of key people associated with the company (founders, executives, etc.). Improves matching for articles that mention people rather than the company name. */
     key_persons?: (string[] | null) | undefined;
     /** Alternative names, abbreviations, or aliases. Helps resolve common variations of the company name. */

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

@@ -0,0 +1,11 @@
+/**
+ * A dataset used to narrow the retrieval scope of a job or monitor, returned with its identifier and name.
+ */
+export interface ConnectedDataset {
+    /** Dataset identifier. */
+    id: string;
+    /** Dataset name as stored. Check `is_deleted` to determine whether the dataset is still active. */
+    name: string;
+    /** True when the dataset has been deleted. */
+    is_deleted?: boolean | undefined;
+}

package/dist/cjs/api/types/ConnectedDataset.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -26,6 +26,8 @@ export interface ConnectedEntity {
     association_type?: string | undefined;
     /** The entity type. */
     type: string;
+    /** External identifier for this entity. Null when not set. */
+    external_entity_id?: (string | null) | undefined;
     /**
      * The stored attributes for this entity. Present only when attributes exist in the database.
      *

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

@@ -1,13 +1,17 @@
 import type * as CatchAllApi from "../index.js";
 /**
- * Request body for creating a single entity. Only `name` is required.
+ * Request body for creating a single entity. The `name` field is required.
+ * You must also provide at least one of: a top-level `description` or a `domain`
+ * inside `additional_attributes.company_attributes`.
  * The more fields you provide, the better the matching quality.
  */
 export interface CreateEntityRequest {
     /** The company or person name. Required and must be non-empty. */
     name: string;
     entity_type?: CatchAllApi.EntityType | undefined;
-    /** Free-text description of the entity used for disambiguation when similar names exist. */
+    /** Free-text description of the entity used for disambiguation when similar names exist. See [Writing effective descriptions](https://www.newscatcherapi.com/docs/web-search-api/concepts/company-search#writing-effective-descriptions) for guidance on improving matching quality. */
     description?: string | undefined;
+    /** Optional external identifier for this entity. Free-form string, not enforced as unique. Use it to store your own CRM, data warehouse, or internal database ID so you can join CatchAll results back to your systems. */
+    external_entity_id?: string | undefined;
     additional_attributes?: CatchAllApi.AdditionalAttributes | undefined;
 }

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

@@ -10,6 +10,21 @@ export interface DatasetResponse {
     description?: (string | null) | undefined;
     /** Total number of entities in this dataset. */
     entity_count?: number | undefined;
+    /**
+     * Count of entities grouped by processing status. Keys are status values
+     * (`ready`, `pending`, `enriching`, `failed`); values are entity counts.
+     */
+    entity_status_breakdown?: Record<string, number> | undefined;
+    /**
+     * Overall health score of the dataset, from 0 to 100. Reflects how many
+     * entities have sufficient identifying information for reliable matching.
+     */
+    health_score?: number | undefined;
+    /**
+     * Health scores broken down by entity type. Keys are entity types
+     * (e.g. `company`); values are scores from 0 to 100.
+     */
+    health_breakdown?: Record<string, number> | undefined;
     latest_status?: CatchAllApi.DatasetStatus | undefined;
     /** ID of the user who created this dataset. */
     created_by_user_id?: string | undefined;

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

@@ -9,6 +9,8 @@ export interface EntityResponse {
     name: string;
     /** Free-text description. */
     description?: (string | null) | undefined;
+    /** External identifier for this entity. Null when not set. */
+    external_entity_id?: (string | null) | undefined;
     additional_attributes?: CatchAllApi.AdditionalAttributes | undefined;
     status: CatchAllApi.EntityStatus;
     /** ID of the user who created this entity. */

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

@@ -14,5 +14,7 @@ export interface EntitySummary {
     status: CatchAllApi.EntityStatus;
     /** Free-text description. */
     description?: (string | null) | undefined;
+    /** External identifier for this entity. Null when not set. */
+    external_entity_id?: (string | null) | undefined;
     attributes?: CatchAllApi.CompanyAttributes | undefined;
 }

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

@@ -0,0 +1,15 @@
+/**
+ * Custom payload formatter for `custom` webhooks. A Liquid template is
+ * rendered at dispatch time to build a fully tailored request body — trim or
+ * rename fields, apply conditional logic, or emit non-JSON formats.
+ */
+export interface FormatterConfigDto {
+    /** Liquid template string rendered at dispatch time. Maximum 10 KB. */
+    template: string;
+    /**
+     * Content-Type of the rendered output. Supported values: `application/json`,
+     * `application/ld+json`, `text/html`, `text/plain`, `text/xml`,
+     * `application/xml`, `text/csv`.
+     */
+    content_type?: string | undefined;
+}

package/dist/cjs/api/types/FormatterConfigDto.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -4,7 +4,12 @@ export interface InitializeResponseDto {
     query: string;
     /** Echo of the context from the request. Null if not provided. */
     context?: (string | null) | undefined;
-    /** Suggested validators for filtering relevant web pages. */
+    /**
+     * Suggested validators for filtering relevant web pages. When the job is
+     * submitted, the system may inject additional validators during the `analyzing`
+     * stage — check the returned `validators[]` in the job status to see the
+     * complete applied set.
+     */
     validators: CatchAllApi.ValidatorSchema[];
     /** Suggested enrichment fields for data extraction. */
     enrichments: CatchAllApi.EnrichmentSchema[];

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

@@ -37,6 +37,10 @@ export interface PullJobResponseDto {
     total_pages?: number | undefined;
     /** Processing mode used for this job. */
     mode?: PullJobResponseDto.Mode | undefined;
+    /** Datasets used to narrow retrieval scope, each with `id` and `name`. */
+    connected_datasets?: CatchAllApi.ConnectedDataset[] | undefined;
+    /** True when the query was submitted as an all-news (watchlist-generic) query. */
+    is_all_news_query?: boolean | undefined;
     /** Present when the job was shared with the authenticated user by another organization member. `null` when the user owns the job. */
     sharing_info?: (CatchAllApi.SharingInfo | null) | undefined;
     /** Array of extracted records with structured data and citations. */

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

@@ -21,6 +21,10 @@ export interface PullMonitorResponseDto {
     all_records?: CatchAllApi.MonitorRecord[] | undefined;
     /** Record limit applied to this monitor's jobs. */
     limit?: (number | null) | undefined;
+    /** Datasets used to narrow retrieval scope, each with `id` and `name`. */
+    connected_datasets?: CatchAllApi.ConnectedDataset[] | undefined;
+    /** True when the reference job was submitted as an all-news (watchlist-generic) query. */
+    is_all_news_query?: boolean | undefined;
 }
 export declare namespace PullMonitorResponseDto {
     /**

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

@@ -13,8 +13,8 @@ export interface WebhookResponseDto {
     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;
+    /** Custom payload formatter. Set only when `type` is `custom`. */
+    formatter_config?: (CatchAllApi.FormatterConfigDto | null) | undefined;
     /** True if the webhook is active; false otherwise. */
     is_active: boolean;
     /** Organization that owns this webhook. */

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

@@ -8,6 +8,7 @@ export * from "./BearerAuthDto.js";
 export * from "./Citation.js";
 export * from "./CompanyAttributes.js";
 export * from "./CompanyEnrichmentOutput.js";
+export * from "./ConnectedDataset.js";
 export * from "./ConnectedEntity.js";
 export * from "./Context.js";
 export * from "./ContinueResponseDto.js";
@@ -44,6 +45,7 @@ export * from "./EntitySummary.js";
 export * from "./EntityType.js";
 export * from "./EntityValidationErrorBody.js";
 export * from "./Error_.js";
+export * from "./FormatterConfigDto.js";
 export * from "./GetPlanLimitsResponseDto.js";
 export * from "./GetWebhookResponseDto.js";
 export * from "./HttpMethod.js";

package/dist/cjs/api/types/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./BearerAuthDto.js"), exports);
 __exportStar(require("./Citation.js"), exports);
 __exportStar(require("./CompanyAttributes.js"), exports);
 __exportStar(require("./CompanyEnrichmentOutput.js"), exports);
+__exportStar(require("./ConnectedDataset.js"), exports);
 __exportStar(require("./ConnectedEntity.js"), exports);
 __exportStar(require("./Context.js"), exports);
 __exportStar(require("./ContinueResponseDto.js"), exports);
@@ -60,6 +61,7 @@ __exportStar(require("./EntitySummary.js"), exports);
 __exportStar(require("./EntityType.js"), exports);
 __exportStar(require("./EntityValidationErrorBody.js"), exports);
 __exportStar(require("./Error_.js"), exports);
+__exportStar(require("./FormatterConfigDto.js"), exports);
 __exportStar(require("./GetPlanLimitsResponseDto.js"), exports);
 __exportStar(require("./GetWebhookResponseDto.js"), exports);
 __exportStar(require("./HttpMethod.js"), exports);

package/dist/cjs/core/file/file.js

@@ -78,6 +78,9 @@ function toMultipartDataPart(file) {
 function getFileWithMetadata(file_1) {
     return __awaiter(this, arguments, void 0, function* (file, { noSniffFileSize } = {}) {
         var _a, _b, _c, _d, _e;
+        if (file == null) {
+            throw new Error(`Expected file to be a Blob, Buffer, ReadableStream, or an object with a "path" or "data" property, but received ${file === null ? "null" : "undefined"}.`);
+        }
         if (isFileLike(file)) {
             return getFileWithMetadata({
                 data: file,

package/dist/cjs/core/form-data-utils/FormDataWrapper.js

@@ -73,6 +73,9 @@ class FormDataWrapper {
     }
     appendFile(key, value) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (value == null) {
+                throw new Error(`File upload for "${key}" received ${value === null ? "null" : "undefined"}. The generated code should not call appendFile with null/undefined — check that optional file fields are guarded before this call.`);
+            }
             const { data, filename, contentType } = yield (0, index_js_1.toMultipartDataPart)(value);
             const blob = yield convertToBlob(data, contentType);
             if (filename) {

package/dist/cjs/core/requestBody.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Spreads caller-supplied `additionalBodyParameters` (from `requestOptions.additionalBodyParameters`)
+ * on top of the request body. Caller-supplied properties win over the endpoint body. When no
+ * additional body parameters are provided, the original body is returned unchanged so serialization
+ * is unaffected.
+ *
+ * The merge only applies to plain-object (JSON object) bodies. When the body is `null`/`undefined`
+ * the additional parameters become the body; when the body is an array or a primitive JSON value it
+ * is returned unchanged, since object properties cannot be spread into it. This mirrors the Python
+ * SDK, which only merges additional body parameters into mapping bodies.
+ */
+export declare function mergeAdditionalBodyParameters(body: unknown, additionalBodyParameters: Record<string, unknown> | undefined): unknown;