newscatcher-catchall-sdk 4.0.0 → 4.0.1

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/CreateEntityRequest.d.ts

@@ -1,13 +1,15 @@
 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;

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/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/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

@@ -45,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

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

package/dist/cjs/core/requestBody.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeAdditionalBodyParameters = mergeAdditionalBodyParameters;
+/**
+ * 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.
+ */
+function mergeAdditionalBodyParameters(body, additionalBodyParameters) {
+    if (additionalBodyParameters == null) {
+        return body;
+    }
+    if (body == null) {
+        return Object.assign({}, additionalBodyParameters);
+    }
+    if (typeof body === "object" && !Array.isArray(body)) {
+        return Object.assign(Object.assign({}, body), additionalBodyParameters);
+    }
+    return body;
+}

package/dist/cjs/core/url/qs.js

@@ -19,7 +19,7 @@ function stringifyObject(obj, prefix = "", options) {
     const parts = [];
     for (const [key, value] of Object.entries(obj)) {
         const fullKey = prefix ? `${prefix}[${key}]` : key;
-        if (value === undefined) {
+        if (value == null) {
             continue;
         }
         if (Array.isArray(value)) {
@@ -39,7 +39,7 @@ function stringifyObject(obj, prefix = "", options) {
             else {
                 for (let i = 0; i < value.length; i++) {
                     const item = value[i];
-                    if (item === undefined) {
+                    if (item == null) {
                         continue;
                     }
                     if (typeof item === "object" && !Array.isArray(item) && item !== null) {

package/dist/cjs/errors/CatchAllApiError.d.ts

@@ -11,4 +11,5 @@ export declare class CatchAllApiError extends Error {
         rawResponse?: core.RawResponse;
         cause?: unknown;
     });
+    get requestId(): string | undefined;
 }

package/dist/cjs/errors/CatchAllApiError.js

@@ -18,6 +18,10 @@ class CatchAllApiError extends Error {
             this.cause = cause;
         }
     }
+    get requestId() {
+        var _a, _b, _c;
+        return (_c = (_b = (_a = this.rawResponse) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b.get("x-request-id")) !== null && _c !== void 0 ? _c : undefined;
+    }
 }
 exports.CatchAllApiError = CatchAllApiError;
 function buildMessage({ message, statusCode, body, }) {

package/dist/cjs/errors/CatchAllApiTimeoutError.d.ts

@@ -1,5 +1,5 @@
-export declare class CatchAllApiTimeoutError extends Error {
-    readonly cause?: unknown;
+import * as errors from "./index.js";
+export declare class CatchAllApiTimeoutError extends errors.CatchAllApiError {
     constructor(message: string, opts?: {
         cause?: unknown;
     });

package/dist/cjs/errors/CatchAllApiTimeoutError.js

@@ -1,18 +1,52 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CatchAllApiTimeoutError = void 0;
-class CatchAllApiTimeoutError extends Error {
+const errors = __importStar(require("./index.js"));
+class CatchAllApiTimeoutError extends errors.CatchAllApiError {
     constructor(message, opts) {
-        super(message);
+        super({
+            message: message,
+            cause: opts === null || opts === void 0 ? void 0 : opts.cause,
+        });
         Object.setPrototypeOf(this, new.target.prototype);
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
         this.name = "CatchAllApiTimeoutError";
-        if ((opts === null || opts === void 0 ? void 0 : opts.cause) != null) {
-            this.cause = opts.cause;
-        }
     }
 }
 exports.CatchAllApiTimeoutError = CatchAllApiTimeoutError;

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "4.0.0";
+export declare const SDK_VERSION = "4.0.1";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "4.0.0";
+exports.SDK_VERSION = "4.0.1";

package/dist/esm/BaseClient.d.mts

@@ -16,6 +16,11 @@ export type BaseClientOptions = {
     fetch?: typeof fetch;
     /** Configure logging for the client. */
     logging?: core.logging.LogConfig | core.logging.Logger;
+    /** Default options for SSE stream reconnection behavior. Has no effect on non-resumable endpoints. */
+    stream?: {
+        reconnectionEnabled?: boolean;
+        maxReconnectionAttempts?: number;
+    };
     /** Override auth. Pass false to disable, a function returning auth headers, an AuthProvider, or auth options. */
     auth?: AuthOption;
 } & HeaderAuthProvider.AuthOptions;
@@ -28,8 +33,15 @@ export interface BaseRequestOptions {
     abortSignal?: AbortSignal;
     /** Additional query string parameters to include in the request. */
     queryParams?: Record<string, unknown>;
+    /** A dictionary containing additional parameters to spread into the request's body. */
+    additionalBodyParameters?: Record<string, unknown>;
     /** Additional headers to include in the request. */
     headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    /** Options for SSE stream reconnection behavior. Has no effect on non-resumable endpoints. */
+    stream?: {
+        reconnectionEnabled?: boolean;
+        maxReconnectionAttempts?: number;
+    };
 }
 export type NormalizedClientOptions<T extends BaseClientOptions = BaseClientOptions> = T & {
     logging: core.logging.Logger;

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "newscatcher-catchall-sdk",
-        "X-Fern-SDK-Version": "4.0.0",
-        "User-Agent": "newscatcher-catchall-sdk/4.0.0",
+        "X-Fern-SDK-Version": "4.0.1",
+        "User-Agent": "newscatcher-catchall-sdk/4.0.1",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

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

@@ -34,7 +34,9 @@ export declare class DatasetsClient {
     listDatasets(request?: CatchAllApi.ListDatasetsRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetListResponse>;
     private __listDatasets;
     /**
-     * Creates a new dataset from a list of existing entity IDs.
+     * Creates a new dataset from a list of existing entity IDs. The optional `description` field here describes the dataset itself — it is separate from the entity-level `description` used for matching.
+     *
+     * Entities must be created before adding them to a dataset. Each entity requires a `name` plus at least one of: a `description` or a `domain`. Use [Create entity](https://www.newscatcherapi.com/docs/web-search-api/api-reference/entities/create-entity) or [Create entities batch](https://www.newscatcherapi.com/docs/web-search-api/api-reference/entities/create-entities-batch) to create entities first.
      *
      * If any of the provided entity IDs do not exist or do not belong to
      * your organization, the request fails with `400`. All entity IDs must
@@ -60,12 +62,12 @@ export declare class DatasetsClient {
     createDataset(request: CatchAllApi.CreateDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetResponse>;
     private __createDataset;
     /**
-     * Creates a new dataset by uploading a CSV file. Each row in the CSV becomes an entity. The `name` and `domain`columns are required; all other columns are optional.
+     * Creates a new dataset by uploading a CSV file. Each row in the CSV becomes an entity. Each row requires a `name` plus at least one of: a `description` or a `domain`; all other columns are optional. Note: `description` in the CSV is the entity's matching description — it is separate from the dataset-level `description` field in the form data.
      *
      * **CSV format:**
      * ```csv
      * name,description,domain,alternative_names,key_persons
-     * NewsCatcher,"AI-powered news data provider",newscatcherapi.com,"NC;NewsCatcher API","Artem Bugara;Maksym Sugonyaka"
+     * NewsCatcher,"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).",newscatcherapi.com,"NewsCatcher CatchAll;NewsCatcher API","Artem Bugara;Maksym Sugonyaka"
      * OpenAI,"Artificial intelligence research company",openai.com,"Open AI","Sam Altman"
      * ```
      *

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

@@ -22,6 +22,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } 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,7 +105,9 @@ export class DatasetsClient {
         });
     }
     /**
-     * Creates a new dataset from a list of existing entity IDs.
+     * Creates a new dataset from a list of existing entity IDs. The optional `description` field here describes the dataset itself — it is separate from the entity-level `description` used for matching.
+     *
+     * Entities must be created before adding them to a dataset. Each entity requires a `name` plus at least one of: a `description` or a `domain`. Use [Create entity](https://www.newscatcherapi.com/docs/web-search-api/api-reference/entities/create-entity) or [Create entities batch](https://www.newscatcherapi.com/docs/web-search-api/api-reference/entities/create-entities-batch) to create entities first.
      *
      * If any of the provided entity IDs do not exist or do not belong to
      * your organization, the request fails with `400`. All entity IDs must
@@ -142,7 +145,7 @@ export class DatasetsClient {
                 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,12 +175,12 @@ export class DatasetsClient {
         });
     }
     /**
-     * Creates a new dataset by uploading a CSV file. Each row in the CSV becomes an entity. The `name` and `domain`columns are required; all other columns are optional.
+     * Creates a new dataset by uploading a CSV file. Each row in the CSV becomes an entity. Each row requires a `name` plus at least one of: a `description` or a `domain`; all other columns are optional. Note: `description` in the CSV is the entity's matching description — it is separate from the dataset-level `description` field in the form data.
      *
      * **CSV format:**
      * ```csv
      * name,description,domain,alternative_names,key_persons
-     * NewsCatcher,"AI-powered news data provider",newscatcherapi.com,"NC;NewsCatcher API","Artem Bugara;Maksym Sugonyaka"
+     * NewsCatcher,"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).",newscatcherapi.com,"NewsCatcher CatchAll;NewsCatcher API","Artem Bugara;Maksym Sugonyaka"
      * OpenAI,"Artificial intelligence research company",openai.com,"Open AI","Sam Altman"
      * ```
      *
@@ -390,7 +393,7 @@ export class DatasetsClient {
                 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,
@@ -453,7 +456,7 @@ export class DatasetsClient {
                 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,
@@ -516,7 +519,7 @@ export class DatasetsClient {
                 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,
@@ -583,7 +586,7 @@ export class DatasetsClient {
                 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/Client.d.mts

@@ -35,10 +35,10 @@ export declare 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.
@@ -50,12 +50,12 @@ export declare 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"]
      *             }
      *         }
      *     })
@@ -65,6 +65,8 @@ export declare 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
@@ -150,7 +152,7 @@ export declare class EntitiesClient {
      *         description: "Updated description",
      *         additional_attributes: {
      *             company_attributes: {
-     *                 alternative_names: ["NC", "NewsCatcher API", "NCA"]
+     *                 alternative_names: ["NewsCatcher CatchAll", "NewsCatcher API", "NCA"]
      *             }
      *         }
      *     })