newscatcher-catchall-sdk 4.0.0 → 4.0.1

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

@@ -22,6 +22,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import { mergeHeaders } from "../../../../core/headers.mjs";
 import * as core from "../../../../core/index.mjs";
+import { mergeAdditionalBodyParameters } from "../../../../core/requestBody.mjs";
 import * as environments from "../../../../environments.mjs";
 import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
 import * as errors from "../../../../errors/index.mjs";
@@ -104,10 +105,10 @@ export class EntitiesClient {
     /**
      * Creates a new company entity and begins background enrichment.
      *
+     * Each entity requires a `name` plus at least one of: a `description` or a `domain`. Providing both is recommended — `domain` is the highest-signal identifier because it is unambiguous; a well-written `description` is the best alternative when no domain is available.
+     *
      * The entity status starts as `pending` and transitions to `ready` once
-     * enrichment completes. Provide as much identifying information as
-     * possible — `domain` is the highest-signal field because it is
-     * unambiguous.
+     * enrichment completes.
      *
      * @param {CatchAllApi.CreateEntityRequest} request
      * @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -119,12 +120,12 @@ export class EntitiesClient {
      *     await client.entities.createEntity({
      *         name: "NewsCatcher",
      *         entity_type: "company",
-     *         description: "AI-powered news data provider",
+     *         description: "NewsCatcher is a data-as-a-service company providing news intelligence APIs including the CatchAll Web Search API (2B+ web pages indexed) and News API (140,000+ sources, 100+ countries).",
      *         additional_attributes: {
      *             company_attributes: {
      *                 domain: "newscatcherapi.com",
      *                 key_persons: ["Artem Bugara", "Maksym Sugonyaka"],
-     *                 alternative_names: ["NC", "NewsCatcher API"]
+     *                 alternative_names: ["NewsCatcher CatchAll", "NewsCatcher API"]
      *             }
      *         }
      *     })
@@ -144,7 +145,7 @@ export class EntitiesClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: request,
+                body: 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,
@@ -174,6 +175,8 @@ export class EntitiesClient {
     /**
      * Creates multiple entities in a single request. Each entity is processed independently — a failure in one does not affect others.
      *
+     * Each entity requires a `name` plus at least one of: a `description` or a `domain`. See [Create entity](https://www.newscatcherapi.com/docs/web-search-api/api-reference/entities/create-entity) for the full field reference.
+     *
      * Returns an array of `{id, status}` objects in the same order as the input array.
      *
      * @param {CatchAllApi.CreateEntitiesBatchRequest} request
@@ -223,7 +226,7 @@ export class EntitiesClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: request,
+                body: 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,
@@ -378,7 +381,7 @@ export class EntitiesClient {
      *         description: "Updated description",
      *         additional_attributes: {
      *             company_attributes: {
-     *                 alternative_names: ["NC", "NewsCatcher API", "NCA"]
+     *                 alternative_names: ["NewsCatcher CatchAll", "NewsCatcher API", "NCA"]
      *             }
      *         }
      *     })
@@ -399,7 +402,7 @@ export class EntitiesClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: _body,
+                body: 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/esm/api/resources/entities/client/requests/UpdateEntityRequest.d.mts

@@ -6,7 +6,7 @@ import type * as CatchAllApi from "../../../../index.mjs";
  *         description: "Updated description",
  *         additional_attributes: {
  *             company_attributes: {
- *                 alternative_names: ["NC", "NewsCatcher API", "NCA"]
+ *                 alternative_names: ["NewsCatcher CatchAll", "NewsCatcher API", "NCA"]
  *             }
  *         }
  *     }

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

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import { mergeHeaders } from "../../../../core/headers.mjs";
 import * as core from "../../../../core/index.mjs";
+import { mergeAdditionalBodyParameters } from "../../../../core/requestBody.mjs";
 import * as environments from "../../../../environments.mjs";
 import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
 import * as errors from "../../../../errors/index.mjs";
@@ -115,7 +116,7 @@ export class JobsClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: request,
+                body: 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,
@@ -172,7 +173,7 @@ export class JobsClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: request,
+                body: 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,
@@ -234,7 +235,7 @@ export class JobsClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: request,
+                body: 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,
@@ -465,7 +466,7 @@ export class JobsClient {
                 contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
-                body: request,
+                body: 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,

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

@@ -20,6 +20,10 @@ export interface SubmitRequestDto {
      * Custom validators for filtering web page clusters.
      *
      * If not provided, validators are generated automatically based on the query.
+     * The system may also inject validators during the `analyzing` stage — for
+     * example, converting a relative time qualifier into an explicit event-date
+     * gate. The returned `validators[]` in the job status shows the complete
+     * applied set, including any system-added ones.
      */
     validators?: CatchAllApi.ValidatorSchema[];
     /**

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

@@ -22,6 +22,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import { mergeHeaders } from "../../../../core/headers.mjs";
 import * as core from "../../../../core/index.mjs";
+import { mergeAdditionalBodyParameters } from "../../../../core/requestBody.mjs";
 import * as environments from "../../../../environments.mjs";
 import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
 import * as errors from "../../../../errors/index.mjs";
@@ -131,7 +132,7 @@ export 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: 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,
@@ -415,7 +416,7 @@ export 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: 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,
@@ -594,7 +595,7 @@ export 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: 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/esm/api/resources/projects/client/Client.mjs

@@ -22,6 +22,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import { mergeHeaders } from "../../../../core/headers.mjs";
 import * as core from "../../../../core/index.mjs";
+import { mergeAdditionalBodyParameters } from "../../../../core/requestBody.mjs";
 import * as environments from "../../../../environments.mjs";
 import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
 import * as errors from "../../../../errors/index.mjs";
@@ -131,7 +132,7 @@ export 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: 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,
@@ -305,7 +306,7 @@ export 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: 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,
@@ -497,7 +498,7 @@ export 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: 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/esm/api/resources/webhooks/client/Client.d.mts

@@ -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/esm/api/resources/webhooks/client/Client.mjs

@@ -22,6 +22,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import { mergeHeaders } from "../../../../core/headers.mjs";
 import * as core from "../../../../core/index.mjs";
+import { mergeAdditionalBodyParameters } from "../../../../core/requestBody.mjs";
 import * as environments from "../../../../environments.mjs";
 import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
 import * as errors from "../../../../errors/index.mjs";
@@ -132,7 +133,7 @@ export 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: 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,
@@ -305,7 +306,7 @@ export 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: 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,
@@ -371,7 +372,7 @@ export 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: 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,
@@ -507,7 +508,7 @@ export 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: 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,
@@ -666,6 +667,79 @@ export class WebhooksClient {
             return 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 = 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 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/esm/api/resources/webhooks/client/requests/CreateWebhookRequestDto.d.mts

@@ -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/esm/api/resources/webhooks/client/requests/TriggerWebhookRequest.d.mts

@@ -0,0 +1,23 @@
+import type * as CatchAllApi from "../../../../index.mjs";
+/**
+ * @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/esm/api/resources/webhooks/client/requests/TriggerWebhookRequest.mjs

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

package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequestDto.d.mts

@@ -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/esm/api/resources/webhooks/client/requests/index.d.mts

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

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

@@ -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/esm/api/types/CreateEntityRequest.d.mts

@@ -1,13 +1,15 @@
 import type * as CatchAllApi from "../index.mjs";
 /**
- * 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;

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

@@ -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/esm/api/types/FormatterConfigDto.d.mts

@@ -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/esm/api/types/FormatterConfigDto.mjs

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

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

@@ -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/esm/api/types/WebhookResponseDto.d.mts

@@ -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/esm/api/types/index.d.mts

@@ -45,6 +45,7 @@ export * from "./EntitySummary.mjs";
 export * from "./EntityType.mjs";
 export * from "./EntityValidationErrorBody.mjs";
 export * from "./Error_.mjs";
+export * from "./FormatterConfigDto.mjs";
 export * from "./GetPlanLimitsResponseDto.mjs";
 export * from "./GetWebhookResponseDto.mjs";
 export * from "./HttpMethod.mjs";

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

@@ -45,6 +45,7 @@ export * from "./EntitySummary.mjs";
 export * from "./EntityType.mjs";
 export * from "./EntityValidationErrorBody.mjs";
 export * from "./Error_.mjs";
+export * from "./FormatterConfigDto.mjs";
 export * from "./GetPlanLimitsResponseDto.mjs";
 export * from "./GetWebhookResponseDto.mjs";
 export * from "./HttpMethod.mjs";

package/dist/esm/core/file/file.mjs

@@ -41,6 +41,9 @@ export 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/esm/core/form-data-utils/FormDataWrapper.mjs

@@ -36,6 +36,9 @@ export 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 toMultipartDataPart(value);
             const blob = yield convertToBlob(data, contentType);
             if (filename) {

package/dist/esm/core/requestBody.d.mts

@@ -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;